vmatare / thinkfan

The minimalist fan control program
GNU General Public License v3.0
552 stars 62 forks source link

Man page fixes #113

Open mariobl opened 4 years ago

mariobl commented 4 years ago

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 commented 3 years ago

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:

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 ;-)