New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[DOC] Array doc #10199
[DOC] Array doc #10199
Conversation
There may be too many examples in the new section; suggest deletions please. |
I think the doc for Array#[]= may be missing the cases where the operand is an array; if so, that will be for a different PR. |
@@ -2284,6 +2294,73 @@ ary_aset_by_rb_ary_splice(VALUE ary, long beg, long len, VALUE val) | |||
* | |||
* Assigns elements in +self+; returns the given +object+. | |||
* | |||
* In brief: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IMO the "in brief" section stops being useful when it tries to exhaustively cover all the cases. It becomes harder to read than the regular documentation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agree; pared.
@peterzhu2118, will you be reviewing this? I've pared down the examples (as I suggested in the OP might be necessary). |
Sorry, I must have missed this. |
Adds section 'In brief' for Array#[]=.