Enhanced RDoc for Struct#4890
Merged
BurdetteLamar merged 2 commits intoruby:masterfrom Sep 24, 2021
BurdetteLamar:struct
Merged
Enhanced RDoc for Struct#4890BurdetteLamar merged 2 commits intoruby:masterfrom BurdetteLamar:struct
BurdetteLamar merged 2 commits intoruby:masterfrom
BurdetteLamar:struct
Conversation
jeremyevans
requested changes
Sep 24, 2021
Contributor
jeremyevans
left a comment
There was a problem hiding this comment.
Thanks for working on this. Only a few requests for changes.
| * struct[member] -> object | ||
| * struct[index] -> object | ||
| * struct[name] -> object | ||
| * struct[n] -> object |
Contributor
There was a problem hiding this comment.
I would use a single line with key instead of name and n. From a caller's perspective, the two lines are the same. Same change for []=
Member
Author
There was a problem hiding this comment.
These two forms seem different to me.
More importantly, replacing name and n with key would force some clumsiness into the discussion:
- +key+th or something perhaps worse.
- Raises NameError if +key+ is not an integer or a member name.
- Raises IndexError if +key+ is an integer that is out of range.
I'd prefer to leave stet.
Contributor
There was a problem hiding this comment.
Since this is just a preference on my part, I'm fine leaving as-is.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Treated: