Miscellaneous documentation improvements in term.rs.#110
Merged
Conversation
This is consistent with e.g. PEP-257. Before, the doc comments were inconsistent on this matter.
Collaborator
|
Looks good to me. Thanks! |
dtolnay
pushed a commit
to dtolnay-contrib/console
that referenced
this pull request
Feb 4, 2022
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.
This PR started small: I initially understood clear_last_lines wrong (I thought it would clear the current line and the n-1 lines before), and have clarified its doc comment accordingly.
While I was there, I made a couple of further clarifications to doc comments in the same file, and also some grammar edits.
Feel free to take whichever changes you want. In particular, I don't have strong opinions about the first commit ("use imperative tense").