Improve similar documentation #13018
Merged
Conversation
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
Try to do a better job of explaining the status quo. Document the reasons why a given array might not return a new array of the same type. Add examples (which are intentionally not doctests since they display uninitialized memory). [ci skip]
|
Seems like a big improvement to me. Guess I'm still pretty uncomfortable with some of the invariants being exposed here (especially mutability), but we don't have any viable contenders for other abstractions at the moment. |
|
Definitely a nice doc improvement of the status quo. |
johnmyleswhite
added a commit
that referenced
this pull request
Sep 8, 2015
Improve similar documentation
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.
Try to do a better job of explaining the status quo. Document the reasons why a given array might not return a new array of the same type. Add examples (which are intentionally not doctests since they display uninitialized memory).
Cc: @johnmyleswhite and @tkelman. I hope that this might closɛ #11574, but I'll let y'all decide that. This is definitely not meant to replace or supersede discussions about how we might be able to change
similarto better suit the needs of custom arrays.