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

more: move help strings to markdown file #4589

Merged
merged 3 commits into from
Mar 24, 2023
Merged

more: move help strings to markdown file #4589

merged 3 commits into from
Mar 24, 2023

Conversation

piotrkwiecinski
Copy link
Contributor

#4368

more --help outputs the following:

target/debug/more --help
A file perusal filter for CRT viewing.

Usage: target/debug/more [OPTIONS] <FILE>...

Arguments:
  [files]...  Path to the files to be read

Options:
  -d, --silent   Display help instead of ringing bell
  -h, --help     Print help
  -V, --version  Print version

@cakebaker cakebaker mentioned this pull request Mar 23, 2023
Closed
tertsdiepraam
tertsdiepraam reviewed Mar 23, 2023
View reviewed changes
Copy link
Member

@tertsdiepraam tertsdiepraam left a comment

Choose a reason for hiding this comment

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

One small suggestion, but looks good!

src/uu/more/src/more.rs Outdated
Comment on lines 34 to 35
const BELL: &str = "\x07";
const USAGE: &str = help_usage!("more.md");
Copy link
Member

Choose a reason for hiding this comment

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

I think it makes sense to reorder these two lines to group the about and usage.

sylvestre
sylvestre reviewed Mar 23, 2023
View reviewed changes
src/uu/more/more.md Outdated
more [OPTIONS] <FILE>...
```

A file perusal filter for CRT viewing.
Copy link
Contributor

Choose a reason for hiding this comment

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

CRT means Cathode Ray Tube
let's remove this old stuff
maybe:

Suggested change
A file perusal filter for CRT viewing.
Display the contents of a text file

@cakebaker cakebaker merged commit cc77a95 into uutils:main Mar 24, 2023
@cakebaker
Copy link
Contributor

Thanks!

@piotrkwiecinski piotrkwiecinski deleted the more-move-string-to-md-file branch March 26, 2023 12:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tertsdiepraam tertsdiepraam tertsdiepraam left review comments

@sylvestre sylvestre sylvestre left review comments

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

Successfully merging this pull request may close these issues.
4 participants
@piotrkwiecinski @cakebaker @sylvestre @tertsdiepraam