Project

General

Profile

Bug #13189

[DOC] Restore class documentation for Struct

Added by stomar (Marcus Stollsteimer) over 2 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Normal
Assignee:
-
Target version:
-
ruby -v:
ruby 2.4.0p0 (2016-12-24 revision 57164) [i686-linux]
[ruby-core:79416]

Description

* struct.c: restore class documentation for Struct
  that disappeared with r46663.

Due to r46663, the class documentation for Struct disappeared.
(The revision inserted the definition of InitVM_Struct between
the rdoc and the definition of Init_Struct.)

The docs are rendered for 2.1: https://docs.ruby-lang.org/en/2.1.0/Struct.html,
but not for later versions, see https://docs.ruby-lang.org/en/2.2.0/Struct.html.
(Same for ri pages).


Files

doc_struct_class.patch (358 Bytes) doc_struct_class.patch stomar (Marcus Stollsteimer), 02/03/2017 08:39 PM

Associated revisions

Revision 02887a56
Added by normal over 2 years ago

doc: restore class documentation for Struct

  • struct.c: restore class documentation for Struct that disappeared with r46663.

Due to r46663, the class documentation for Struct disappeared.
(The revision inserted the definition of InitVM_Struct between
the rdoc and the definition of Init_Struct.)

The docs are rendered for 2.1: https://docs.ruby-lang.org/en/2.1.0/Struct.html,
but not for later versions, see: https://docs.ruby-lang.org/en/2.2.0/Struct.html
(Same for ri pages).

[ruby-core:79416] [Bug #13189]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57522 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 57522
Added by normalperson (Eric Wong) over 2 years ago

doc: restore class documentation for Struct

  • struct.c: restore class documentation for Struct that disappeared with r46663.

Due to r46663, the class documentation for Struct disappeared.
(The revision inserted the definition of InitVM_Struct between
the rdoc and the definition of Init_Struct.)

The docs are rendered for 2.1: https://docs.ruby-lang.org/en/2.1.0/Struct.html,
but not for later versions, see: https://docs.ruby-lang.org/en/2.2.0/Struct.html
(Same for ri pages).

[ruby-core:79416] [Bug #13189]

Revision 57522
Added by normal over 2 years ago

doc: restore class documentation for Struct

  • struct.c: restore class documentation for Struct that disappeared with r46663.

Due to r46663, the class documentation for Struct disappeared.
(The revision inserted the definition of InitVM_Struct between
the rdoc and the definition of Init_Struct.)

The docs are rendered for 2.1: https://docs.ruby-lang.org/en/2.1.0/Struct.html,
but not for later versions, see: https://docs.ruby-lang.org/en/2.2.0/Struct.html
(Same for ri pages).

[ruby-core:79416] [Bug #13189]

Revision 57522
Added by normal over 2 years ago

doc: restore class documentation for Struct

  • struct.c: restore class documentation for Struct that disappeared with r46663.

Due to r46663, the class documentation for Struct disappeared.
(The revision inserted the definition of InitVM_Struct between
the rdoc and the definition of Init_Struct.)

The docs are rendered for 2.1: https://docs.ruby-lang.org/en/2.1.0/Struct.html,
but not for later versions, see: https://docs.ruby-lang.org/en/2.2.0/Struct.html
(Same for ri pages).

[ruby-core:79416] [Bug #13189]

Revision f3e3ac78
Added by naruse (Yui NARUSE) over 2 years ago

merge revision(s) 57522: [Backport #13189]

    doc: restore class documentation for Struct

    * struct.c: restore class documentation for Struct
      that disappeared with r46663.

    Due to r46663, the class documentation for Struct disappeared.
    (The revision inserted the definition of `InitVM_Struct` between
    the rdoc and the definition of `Init_Struct`.)

    The docs are rendered for 2.1: <https://docs.ruby-lang.org/en/2.1.0/Struct.html>,
    but not for later versions, see: <https://docs.ruby-lang.org/en/2.2.0/Struct.html>
    (Same for `ri` pages).

    [ruby-core:79416] [Bug #13189]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_4@57901 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 57901
Added by naruse (Yui NARUSE) over 2 years ago

merge revision(s) 57522: [Backport #13189]

doc: restore class documentation for Struct

* struct.c: restore class documentation for Struct
  that disappeared with r46663.

Due to r46663, the class documentation for Struct disappeared.
(The revision inserted the definition of `InitVM_Struct` between
the rdoc and the definition of `Init_Struct`.)

The docs are rendered for 2.1: <https://docs.ruby-lang.org/en/2.1.0/Struct.html>,
but not for later versions, see: <https://docs.ruby-lang.org/en/2.2.0/Struct.html>
(Same for `ri` pages).

[ruby-core:79416] [Bug #13189]

Revision 6781722a
Added by nagachika (Tomoyuki Chikanaga) about 2 years ago

merge revision(s) 57522: [Backport #13189]

    doc: restore class documentation for Struct

    * struct.c: restore class documentation for Struct
      that disappeared with r46663.

    Due to r46663, the class documentation for Struct disappeared.
    (The revision inserted the definition of `InitVM_Struct` between
    the rdoc and the definition of `Init_Struct`.)

    The docs are rendered for 2.1: <https://docs.ruby-lang.org/en/2.1.0/Struct.html>,
    but not for later versions, see: <https://docs.ruby-lang.org/en/2.2.0/Struct.html>
    (Same for `ri` pages).

    [ruby-core:79416] [Bug #13189]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_3@58031 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 58031
Added by nagachika (Tomoyuki Chikanaga) about 2 years ago

merge revision(s) 57522: [Backport #13189]

doc: restore class documentation for Struct

* struct.c: restore class documentation for Struct
  that disappeared with r46663.

Due to r46663, the class documentation for Struct disappeared.
(The revision inserted the definition of `InitVM_Struct` between
the rdoc and the definition of `Init_Struct`.)

The docs are rendered for 2.1: <https://docs.ruby-lang.org/en/2.1.0/Struct.html>,
but not for later versions, see: <https://docs.ruby-lang.org/en/2.2.0/Struct.html>
(Same for `ri` pages).

[ruby-core:79416] [Bug #13189]

Revision fd69ec05
Added by usa (Usaku NAKAMURA) about 2 years ago

merge revision(s) 57522: [Backport #13189]

    doc: restore class documentation for Struct

    * struct.c: restore class documentation for Struct
      that disappeared with r46663.

    Due to r46663, the class documentation for Struct disappeared.
    (The revision inserted the definition of `InitVM_Struct` between
    the rdoc and the definition of `Init_Struct`.)

    The docs are rendered for 2.1: <https://docs.ruby-lang.org/en/2.1.0/Struct.html>,
    but not for later versions, see: <https://docs.ruby-lang.org/en/2.2.0/Struct.html>
    (Same for `ri` pages).

    [ruby-core:79416] [Bug #13189]

git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/branches/ruby_2_2@58113 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

Revision 58113
Added by usa (Usaku NAKAMURA) about 2 years ago

merge revision(s) 57522: [Backport #13189]

doc: restore class documentation for Struct

* struct.c: restore class documentation for Struct
  that disappeared with r46663.

Due to r46663, the class documentation for Struct disappeared.
(The revision inserted the definition of `InitVM_Struct` between
the rdoc and the definition of `Init_Struct`.)

The docs are rendered for 2.1: <https://docs.ruby-lang.org/en/2.1.0/Struct.html>,
but not for later versions, see: <https://docs.ruby-lang.org/en/2.2.0/Struct.html>
(Same for `ri` pages).

[ruby-core:79416] [Bug #13189]

History

#1

Updated by Anonymous over 2 years ago

  • Status changed from Open to Closed

Applied in changeset r57522.


doc: restore class documentation for Struct

  • struct.c: restore class documentation for Struct that disappeared with r46663.

Due to r46663, the class documentation for Struct disappeared.
(The revision inserted the definition of InitVM_Struct between
the rdoc and the definition of Init_Struct.)

The docs are rendered for 2.1: https://docs.ruby-lang.org/en/2.1.0/Struct.html,
but not for later versions, see: https://docs.ruby-lang.org/en/2.2.0/Struct.html
(Same for ri pages).

[ruby-core:79416] [Bug #13189]

Updated by nagachika (Tomoyuki Chikanaga) over 2 years ago

  • Backport changed from 2.2: UNKNOWN, 2.3: UNKNOWN, 2.4: UNKNOWN to 2.2: REQUIRED, 2.3: REQUIRED, 2.4: REQUIRED

Updated by stomar (Marcus Stollsteimer) over 2 years ago

@normal (@Anonymous)

Regarding commit messages / further explanations:

I wasn't aware that the complete description would be included
in the commit message; is there a preferred way on
bugs.ruby-lang.org for providing a (suggested) commit message
and additional, more verbose explanations?

(On GitHub there is a natural distinction between the
commit message and the PR description, but not for Redmine.)

Updated by normalperson (Eric Wong) over 2 years ago

sto.mar@web.de wrote:

@normal (@Anonymous)

Regarding commit messages / further explanations:

I wasn't aware that the complete description would be included
in the commit message; is there a preferred way on
bugs.ruby-lang.org for providing a (suggested) commit message
and additional, more verbose explanations?

Yes, I prefer that, at least. Having to go online or even go
out-of-band into my mail archives to look for the explanation of
change is often inconvenient. Explaining in commit message is
is analogous to the inline-cache in YARV to improve locality :)

Anyways, it is expected for git.git (and linux.git) for commit
messages to be complete enough to justify a change.

To the contrary, I dislike GNU ChangeLog entry style used in
Ruby ("make change"). GNU-style describes what changed; but
what changed should already be obvious from reading a diff.
The "why" is not always obvious, and should be explained.

For Ruby, I try to remember to do both (why and what) because
matz liked GNU-style entries, and nobody complained about my
commit messages being too informative :)

If you wish (and it would make my life as patch applyer easier :)
you may use "git format-patch" to generate the patch with
full commit message or use "git request-pull" to format a pull
request pointing to any anonymously-accessible git server.

I will also try to remember to use --add-author-from option
with "git svn" to give you proper credit :x

(On GitHub there is a natural distinction between the
commit message and the PR description, but not for Redmine.)

For a single change, I prefer the commit message cover everything.
For multiple changes, an overview of the series along with
"git request-pull" helps summarize the changes.

Updated by stomar (Marcus Stollsteimer) over 2 years ago

Thanks for the explanation and the hint to git format-patch; I'll try that for the next PR.

Updated by naruse (Yui NARUSE) over 2 years ago

  • Backport changed from 2.2: REQUIRED, 2.3: REQUIRED, 2.4: REQUIRED to 2.2: REQUIRED, 2.3: REQUIRED, 2.4: DONE

ruby_2_4 r57901 merged revision(s) 57522.

Updated by nagachika (Tomoyuki Chikanaga) about 2 years ago

  • Backport changed from 2.2: REQUIRED, 2.3: REQUIRED, 2.4: DONE to 2.2: REQUIRED, 2.3: DONE, 2.4: DONE

ruby_2_3 r58031 merged revision(s) 57522.

Updated by usa (Usaku NAKAMURA) about 2 years ago

  • Backport changed from 2.2: REQUIRED, 2.3: DONE, 2.4: DONE to 2.2: DONE, 2.3: DONE, 2.4: DONE

ruby_2_2 r58113 merged revision(s) 57522.

Also available in: Atom PDF