Skip to content
This repository has been archived by the owner on Oct 22, 2019. It is now read-only.

Internal refactoring and documentation #3

Merged
merged 21 commits into from
Sep 30, 2019

Conversation

zrzka
Copy link
Contributor

@zrzka zrzka commented Sep 27, 2019

  • .travis.yml updated to build PRs & master branch only
  • Forbid unused_must_use warning -> error
  • Mark reexports in the documentation as reexports (#[doc(no_inline)])
  • Code refactoring in the same way as I did in the -cursor (& no breaking changes)

Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
@zrzka zrzka requested a review from TimonPost as a code owner September 27, 2019 11:06
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
@zrzka zrzka changed the title [WIP] Internal refactoring and documentation Internal refactoring and documentation Sep 27, 2019
@zrzka
Copy link
Contributor Author

zrzka commented Sep 27, 2019

@TimonPost removed [WIP] -> ready for review. Same stuff which was done for the -cursor.

@zrzka
Copy link
Contributor Author

zrzka commented Sep 27, 2019

@TimonPost err, taking back, I forgot about the README.md.

Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
@zrzka
Copy link
Contributor Author

zrzka commented Sep 27, 2019

Fixed, ready.

Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
src/lib.rs Outdated
/// - Raw screen
/// - Exit the current process
///
/// Check `/examples/` in the library for more specific examples.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's add an example here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like an outdated comment?

```toml
[dependencies]
# All crossterm features are enabled by default.
crossterm = "0.11"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

crossterm_input?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is intentional. See the cursor's Getting started. Same here. Why intentional? Yep, it's a crossterm_terminal crate, but I kind of want to "force" users to use crossterm crate.

};

if clear_type == ClearType::All {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am unsure if this is really needed here. Maybe we should re-validate this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Then we should create an issue for this as this PR goal is no breaking / functional changes at all. Just internal refactor & docs.

Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
Signed-off-by: Robert Vojta <rvojta@me.com>
@TimonPost TimonPost merged commit fb0e721 into master Sep 30, 2019
@zrzka zrzka deleted the zrzka/internal-refactoring-and-docs branch October 1, 2019 14:44
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants