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

Spelling, grammar, and other improvements #1024

Merged
merged 11 commits into from
Jan 12, 2021
Merged

Conversation

pgaskin
Copy link
Collaborator

@pgaskin pgaskin commented Dec 13, 2020

No description provided.

@pgaskin pgaskin marked this pull request as ready for review January 11, 2021 16:34
@pgaskin
Copy link
Collaborator Author

pgaskin commented Jan 11, 2021

@flyingmutant, @nefthy, this is ready for review.

@flyingmutant
Copy link
Member

Typo fixes in the code all look good. However, as for the man page -- I am not a native speaker, can you please help with proofreading the text a bit, @nefthy?

Doc/cmus.txt Outdated Show resolved Hide resolved
@pgaskin
Copy link
Collaborator Author

pgaskin commented Jan 11, 2021

proofreading the text a bit, @nefthy?

To help, the main changes I made were:

  • Rewrapping the text to 80 cols (this VSCode extension is really useful).
    • If this makes it hard for you to follow the real changes, I suggest replacing (.)\n\t([A-Za-z*]) with $1 $2 and enabling wrapping in your editor before comparing the files.
  • Making word forms consistent within the config and command sections.
  • Fixing missing articles before nouns (mostly just the).
  • Fixing misused commas (mostly extraneous ones which change the meaning of the sentence, or ones which should have been semicolons or periods).
  • Rewriting a few sections/paragraphs which were overly wordy, incorrect, or unclear
    • LIBRARY VIEW SORTING: This one was the worst. The style was completely different from the rest, it jumped around, and it left more questions than it answered about some of the sorting behaviour. I needed to check the code for this one.
    • The help text for some of the commands was quite confusing when it talked about exceptional behaviour (e.g. what happens if no arguments are provided) as different possibilities for the command rather than as exceptions separate from the main description.
    • FILES: It wasn't clear what each file actually did compared to the others.
  • Removing default bindings from individual command help text (they are duplicates of the main default section).
  • Making the style consistent, more technical, and slightly more formal.
    • I might have missed a few areas which were almost good enough, but I've fixed the worst occurrences.

Comment on lines +15 to +17
cmus is a lightweight ncurses music player. It supports various output methods
by using dynamically-loaded output plugins. cmus has configurable keybindings
and can be controlled externally using *cmus-remote*(1).
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

If anyone has better suggestions for this, I'd be happy to hear them. I only fixed the sentence structure and wording of the previous description, which I don't really like to begin with.

@flyingmutant
Copy link
Member

@pgaskin I've merged #1037, can you please rebase this one?

@pgaskin
Copy link
Collaborator Author

pgaskin commented Jan 12, 2021

@flyingmutant, I've merged master into it (I can rebase it if you really want me to, but you're squashing it anyways so it doesn't really make much difference other than making it harder to manage my exp branch).

Doc/cmus.txt Outdated Show resolved Hide resolved
@flyingmutant flyingmutant merged commit 3511023 into cmus:master Jan 12, 2021
@flyingmutant
Copy link
Member

Thank you!

@pgaskin pgaskin deleted the proofread branch January 13, 2021 00:46
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.

2 participants