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

Man page fixes #113

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

Man page fixes #113

wants to merge 2 commits into from

Conversation

mariobl
Copy link
Contributor

@mariobl mariobl commented Oct 8, 2020

While translating the man pages, I found some typos and formattings which doesn#t match the rules described in man(7). Additionally, I've added file headers with license declarations.

@vmatare
Copy link
Owner

vmatare commented Sep 11, 2021

Thanks a lot for your work and sorry for getting back on it so late. I see some changes that I like, but also some things I don't. The most ovious problem I see is that the word thinkfan should not be set in bold everywhere. It creates too much visual clutter, i.e. drawing attention to the word thinkfan does not improve the visual ergonomics of the text.

The next thing is that in many places where you're changing bold to italic or vice versa, you're breaking a convention I've tried to establish/maintain (at least in the config manpage, but maybe not entirely successfully). The convention is this:

  • Every string that can appear verbatim in the config is bold
  • Names for placeholders, i.e. everything that is filled out by the user and does not appear verbatim in the config is italic

It would be great if you could change your PR accordingly. Writing good documentation is difficult and time-consuming, so I can use all the help I can get ;-)

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