Sarcasm / irony-mode

A C/C++ minor mode for Emacs powered by libclang
GNU General Public License v3.0
901 stars 98 forks source link

Add man page source in rst (reStructuredText) format #441

Closed sten0 closed 6 years ago

sten0 commented 6 years ago

This pull request resolves #440

Would you please look at lines 39-to-44 and add short descriptions? I would have added generic ones, but I didn't want to assume they were 100% generic ;-) In other news, I learned that rst2man reflows paragraphs, so long lines vs flowed paragraphs don't seem to matter. Unfortunately these means words always end up hyphenated.

If you'd like me to do any further work before merging this pull request, just let me know!

Cheers, Nicholas

sten0 commented 6 years ago

Hi Guillaume, I've implemented all of your edits, and will wait for your comments on "-i" before committing and pushing an update. Thank you, this makes the documentation much more clear :-)

Sarcasm commented 6 years ago

Yes I will squash, I prefer the clean history as well.

Thank you for the man page, I think if I have to write one myself one day, I will do it in rst, the result looks good! :)

sten0 commented 6 years ago

Thank you for the opportunity to learn rst syntax and for your assistance with the sections that were unclear to me. Also, I was so relieved you didn't ask me to work with groff/troff ! :-)

On 2 October 2017 at 16:44, Guillaume Papin notifications@github.com wrote:

Yes I will squash, I prefer the clean history as well.

Thank you for the man page, I think if I have to write one myself one day, I will do it in rst, the result looks good! :)

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub https://github.com/Sarcasm/irony-mode/pull/441#issuecomment-333659236, or mute the thread https://github.com/notifications/unsubscribe-auth/AK2HAWhu4r88wHa7ylUktY77Vu5nXsWoks5soUsXgaJpZM4PqESL .

Sarcasm commented 6 years ago

Hehe, I tried groff/trofff once, and I did not like it. :P