Skip to content

More documentation improvements: clarifying behaviour #120

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Apr 30, 2022
Merged

More documentation improvements: clarifying behaviour #120

merged 10 commits into from
Apr 30, 2022

Conversation

grunweg
Copy link
Contributor

@grunweg grunweg commented Apr 29, 2022 •
edited
Loading

In addition to some minor stylistic edits (see inline), I

  • clarified how the cursor is positioned after the various clear functions
  • clarify that indices in move_to are 0-based. (I was wondering about that; it seems harmless to guarantee this since the ANSI code move-to sequences that this is based on have the same semantics.)
  • document how move_cursor_{left,right,up,down} behave when called with a larger value than possible.

Based on #119; only the last four commits are new.

grunweg added 10 commits January 20, 2022 10:07
@grunweg
doc: Use imperative mode for doc comments in term.rs.
4652d43 
This is consistent with e.g. PEP-257.
Before, the doc comments were inconsistent on this matter.
@grunweg
doc: Minor grammar edits to documentation comments in term.rs.
5667759
@grunweg
doc: Fix doc comments for move_cursor_{left,right}.
30f8005
@grunweg
doc: Clarify doc comments for move_cursor_to and clear_last_lines.
7250fd1
@grunweg
doc: Two minor wording tweaks.
0fb376f
@grunweg
Merge branch 'console-rs:master' into master
465d9be
@grunweg
doc: End all doc comments with a period.
c75de7e
@grunweg
doc: Improve doc comments for the clear_* functions.
2ab6622 
The comment for clear_to_end_of_screen was simply wrong.
@grunweg
doc: Clarify that indices in move_cursor_to are 0-based.
9ccc05d
@grunweg
Document the behaviour of move_cursor_{left,right,up,down} when calle…
60716ea 
…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 pksunkara merged commit b3ecb7d into console-rs:master Apr 30, 2022
@grunweg grunweg mentioned this pull request Apr 30, 2022
Closed
@grunweg
Copy link
Contributor Author

grunweg commented Apr 30, 2022

Thanks for the fast review!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@pksunkara pksunkara pksunkara approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@grunweg @pksunkara