Updating fcpgenkey, fcpinvertkey man pages to 0.2.5

hyphanet / pyFreenet

Python FCPv2 library and utilities

https://freenetproject.org/

Other

60 stars 24 forks source link

Updating fcpgenkey, fcpinvertkey man pages to 0.2.5 #10

Closed Soliloque closed 9 years ago

Soliloque commented 9 years ago

Then a few cosmetic changes and modifying other man pages to keep those uniform.

Removed html version of man pages as those are 1) redondant 2) obsolete 3) automaticaly generated from the other man pages version.

Valided original author's email adress.

Thynix commented 9 years ago

Ooh, getting rid of those HTML versions will be nice. Some of these commit messages do not meet the commit message standards. Could you please update them?

Soliloque commented 9 years ago

Done.

Thynix commented 9 years ago

The way the author sections are written makes it sound like this was written in one go in 2006, and hasn't been changed since, which isn't the case.

Any ideas on how to avoid that?

Soliloque commented 9 years ago

It was spelt wrong. ;)

Thynix commented 9 years ago

I'm sorry, these still don't meet the commit message standards. Are they unclear? I'd like to clarify them - any suggestions?

For example, in pyFreenet man pages: Change SYNTAX->SYNOPSIS the context doesn't need to include "pyFreenet" because it is already in the pyFreenet repo. The standards suggest a context of the "area / module" if helpful, which could mean a class but in this case means the start of the path. Words are also preferable to symbols, so I'd recommend changing this one to manpages: rename SYNTAX section to SYNOPSIS.

Commit summaries (meaning the first line) should not end with a full stop.

The rest are not imperative - meaning commands to the codebase:

updating -> update
new -> add
Removed -> Remove
AUTHOR sections expanded -> expand AUTHOR sections

Thanks!

Soliloque commented 9 years ago

English isn't my native language. The PyFCP applications and library were originaly written by David McNab (aum) in May-June, 2006 and are maintained by the Freenet Project team.

Thynix commented 9 years ago

Alright - sorry about that. Would you like me to merge once the content looks good and fix the commit messages where necessary?

That sounds good for the authors section. originaly -> originally. (I assume you plan to do the pyFCP -> pyFreenet later?)

Soliloque commented 9 years ago

Answering to a lot of things at once.

I'm fixing everything right now. I don't want to give you too much job.
As I wrote him, I suppose McNab will tell me if he doesn't want to be a maintainer anymore. I'll remove him if needed.
I don't want to replace pyFCP by pyFreenet only on a few files and further add to the imprecision.

Soliloque commented 9 years ago

I think it begins to look good. Please notice the last commit and the ones about AUTHORS and email.

Thynix commented 9 years ago

Looks good, thanks!

Soliloque commented 9 years ago

Thank you for your patience. Should I notify you next time I do a pull request?

Thynix commented 9 years ago

No worries! :) Up to you - I should get an email, but if it looks like I've forgotten feel free to poke me about it.