Enhanced RDoc #58
Merged
Enhanced RDoc #58
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
BurdetteLamar
commented
Jul 6, 2022
•
BurdetteLamar
commented
- Brings a dozen call-seq schemas into compliance with the doc guide.
- Adds links to section "Argument start" where needed.
- Revises (minorly) ::today.
- Otherwise, does not disturb existing text.
peterzhu2118
reviewed
Jul 7, 2022
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
Co-authored-by: Peter Zhu <peter@peterzhu.ca>
peterzhu2118
reviewed
Jul 7, 2022
ext/date/date_core.c
Outdated
| @@ -2473,6 +2473,8 @@ date_s__valid_jd_p(int argc, VALUE *argv, VALUE klass) | |||
| * | |||
| * Date.valid_jd?(2451944) # => true | |||
| * | |||
| * See {Argument start}[rdoc-ref:Date@Argument+start]. | |||
There was a problem hiding this comment.
I think we should use something like
Suggested change
| * See {Argument start}[rdoc-ref:Date@Argument+start]. | |
| * See {Argument +start+}[rdoc-ref:Date@Argument+start]. |
to match the title it links to.
There was a problem hiding this comment.
I just checked this, it looks like RDoc doesn't handle formatting inside links, so it ends up being broken. Sorry about that. Maybe we can revert back to what it was like originally or something like {Argument "start"}[rdoc-ref:Date@Argument+start] instead?
There was a problem hiding this comment.
Original, or maybe See argument {start} [rdoc-ref:Date@Argument+start]?
There was a problem hiding this comment.
👍 I like See argument {start}[rdoc-ref:Date@Argument+start]
|
@peterzhu2118, ready. |
peterzhu2118
approved these changes
Jul 7, 2022
| @@ -4508,6 +4515,8 @@ date_s__parse(int argc, VALUE *argv, VALUE klass) | |||
| * Raise an ArgumentError when the string length is longer than _limit_. | |||
| * You can stop this check by passing `limit: nil`, but note that | |||
| * it may take a long time to parse. | |||
| ^ | |||
matzbot
pushed a commit
to ruby/ruby
that referenced
this pull request
Jul 7, 2022
Brings a dozen call-seq schemas into compliance with the doc guide.
Adds links to section "Argument start" where needed.
Revises (minorly) ::today.
Otherwise, does not disturb existing text.
ruby/date@9aec11df50
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.