docs: in_place explanation #70
Closed
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
Improve understanding of sort_and_reorder() method by including algorithmic description for parameter 'in_place'.
|
"In-place" is a widely understood term in computer science, so I'm not really seeing the value in linking it. If we link this, almost everything needs a link in the documentation, which seems unnecessary. I appreciate and understand that it was confusing for you, and that's totally fine, but adding a link to the documentation which has an expectation of pre-knowledge in this area seems somewhat superfluous. |
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.
If we have to link a Wikipedia Page for the an ideal understanding of this parameter (and thus method), it should probably be included in the documentation. Also, so it isn't ambiguous with "in place" in the context of captions.
Reference: Issue #69