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.

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

truncate.1: Minor polish #1568

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

concussious
Copy link
Contributor

I was studying this manual and noticed some possible improvements.

  • Rewrite the document description to fit in one line, adding "resize" to the keywords, removing only "length" as a keyword.

  • Switch to human readable ls output for examples. This makes them fit on standard console, and makes it easier to understand since the example operations are in megabytes already.

  • Improve English and roff grammar, eliminating a linter warning and improving rapid reader comprehension.

  • Remove prompt from an example which has it, to create consistency with the rest of them.

  • Tag spdx

Cc @mhorne, @sergio-carlavilla

+ add `resize` to description (search keywords)
+ remove redundant `the length of`, duplicate `files` and `truncate`
+ description is now one line on standard console
+ fold a line to eliminate linter warning + tag spdx

MFC after:	3 days
+ switch examples to human readable sizes, with consistent spacing
+ `Downsize ... in 5 Megabytes` >> `Downsize ... by 5 Megabytes`
+ remove prompt from lone example with prompt for consistency
+ examples now fit on standard console without wrapping

MFC after:	3 days
@concussious concussious changed the title truncate.1: Polish truncate.1: Minor polish Jan 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant