More documentation improvements: clarifying behaviour#120
Merged
pksunkara merged 10 commits intoconsole-rs:masterfrom Apr 30, 2022
Merged
More documentation improvements: clarifying behaviour#120pksunkara merged 10 commits intoconsole-rs:masterfrom
pksunkara merged 10 commits intoconsole-rs:masterfrom
Conversation
This is consistent with e.g. PEP-257. Before, the doc comments were inconsistent on this matter.
The comment for clear_to_end_of_screen was simply wrong.
…d with a larger value than possible. Since that behaviour (moving the cursor as far as possible) is relatively benign, only documenting this and not changing e.g. the function signature seems reasonable.
pksunkara
approved these changes
Apr 30, 2022
Contributor
Author
|
Thanks for the fast review! |
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.
In addition to some minor stylistic edits (see inline), I
Based on #119; only the last four commits are new.