Skip to content
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

Further documentation improvements #119

Closed
wants to merge 9 commits into from
Closed

Further documentation improvements #119

wants to merge 9 commits into from

Commits on Jan 20, 2022

  1. doc: Use imperative mode for doc comments in term.rs. 

    This is consistent with e.g. PEP-257.
Before, the doc comments were inconsistent on this matter.
    @grunweg
    grunweg committed Jan 20, 2022
    Configuration menu
    Copy the full SHA
    4652d43 View commit details
    Browse the repository at this point in the history

  2. doc: Minor grammar edits to documentation comments in term.rs.

    @grunweg
    grunweg committed Jan 20, 2022
    Configuration menu
    Copy the full SHA
    5667759 View commit details
    Browse the repository at this point in the history

  3. doc: Fix doc comments for move_cursor_{left,right}.

    @grunweg
    grunweg committed Jan 20, 2022
    Configuration menu
    Copy the full SHA
    30f8005 View commit details
    Browse the repository at this point in the history

  4. doc: Clarify doc comments for move_cursor_to and clear_last_lines.

    @grunweg
    grunweg committed Jan 20, 2022
    Configuration menu
    Copy the full SHA
    7250fd1 View commit details
    Browse the repository at this point in the history

  5. doc: Two minor wording tweaks.

    @grunweg
    grunweg committed Jan 20, 2022
    Configuration menu
    Copy the full SHA
    0fb376f View commit details
    Browse the repository at this point in the history

Commits on Feb 17, 2022

  1. Merge branch 'console-rs:master' into master

    @grunweg
    grunweg committed Feb 17, 2022
    Configuration menu
    Copy the full SHA
    465d9be View commit details
    Browse the repository at this point in the history

  2. Document the current behaviour of clear_last_lines when called with a… 

    … too large argument.
    @grunweg
    grunweg committed Feb 17, 2022
    Configuration menu
    Copy the full SHA
    c526c5c View commit details
    Browse the repository at this point in the history

Commits on Apr 29, 2022

  1. wip: Add function to compute the current cursor position. 

    The implementation is a proof-of-concept, and now fully polished yet.
    @grunweg
    grunweg committed Apr 29, 2022
    Configuration menu
    Copy the full SHA
    eb8b377 View commit details
    Browse the repository at this point in the history

  2. Make sure clear_last_lines never clears below the current cursor. 

    Instead, check the number of rows above the cursor position,
and error if passed a too large number.
    @grunweg
    grunweg committed Apr 29, 2022
    Configuration menu
    Copy the full SHA
    0a2c4ce View commit details
    Browse the repository at this point in the history