[DOC] Repair format of What's Here sections in object.c #5722
Conversation
| * - {!}[#method-i-21]: Returns the boolean negation of +self+: +true+ or +false+. | ||
| * - {!=}[#method-i-21-3D]: Returns whether +self+ and the given object are _not_ equal. |
There was a problem hiding this comment.
| * - {!}[#method-i-21]: Returns the boolean negation of +self+: +true+ or +false+. | |
| * - {!=}[#method-i-21-3D]: Returns whether +self+ and the given object are _not_ equal. | |
| * - #!: Returns the boolean negation of +self+: +true+ or +false+. | |
| * - #!=: Returns whether +self+ and the given object are _not_ equal. |
There was a problem hiding this comment.
The suggested revisions above do not become links on my system:
- $ ruby --version
ruby 3.1.0p0 (2021-12-25 revision fb4df44) [x64-mingw-ucrt] - $ rdoc --version
6.4.0
Is this fixed in later versions?
There are many more like this in the What's Here sections. When they are no longer needed, I'll be happy to do a sweep through to clean them up.
There was a problem hiding this comment.
It is fixed at ruby/rdoc#865 and has been merged to the ruby master, but rdoc is not released yet.
| * - {!~}[#method-i-21~]: Returns +true+ if +self+ does not match the given object, | ||
| * otherwise +false+. | ||
| * - {<=>}[#method-i-3C-3D-3E]: Returns 0 if +self+ and the given object +object+ are the same | ||
| * object, or if <tt>self == object</tt>; otherwise returns +nil+. |
There was a problem hiding this comment.
| * - {!~}[#method-i-21~]: Returns +true+ if +self+ does not match the given object, | |
| * otherwise +false+. | |
| * - {<=>}[#method-i-3C-3D-3E]: Returns 0 if +self+ and the given object +object+ are the same | |
| * object, or if <tt>self == object</tt>; otherwise returns +nil+. | |
| * - #!~: Returns +true+ if +self+ does not match the given object, | |
| * otherwise +false+. | |
| * - #<=>: Returns 0 if +self+ and the given object +object+ are the same | |
| * object, or if <tt>self == object</tt>; otherwise returns +nil+. |
| * - #spawn:: Executes the given command and returns its pid without waiting | ||
| * for completion. | ||
| * - #system:: Executes the given command in a subshell. | ||
| * - {`command`}[#method-i-60]: Returns the standard output of running +command+ in a subshell. |
There was a problem hiding this comment.
I think the canonical notation is #` here, and command` is extraneous.
Do you think #`command` should be parsed as single method reference?
There was a problem hiding this comment.
I'm agnostic on this one. In the What's Here section, #</tt> in source would become a link with just the one character <tt>, a tiny target even if correct. How would you like this to be?
Also, #` did not link on my machine (versions same as above).
|
@nobu, can we leave these links as-is for now, and deal with all such (in all classes) all at once, and later? If so, I'll still need an approval from you or @jeremyevans. |
|
Do you mean to change just the method list styles? |
I mean to merge now, then fix after the fix is released. Ok? |
|
When the fix at 385 is released, I will sweep through all classes that should make use of it. |
|
Sorry, @nobu, I did not understand you about merging this; now I do. |
No description provided.