search

boskee / Minecraft

Simple Minecraft-inspired program using Python and Pyglet
MIT License
207 stars 33 forks source link

Markdown or reStructuredText? #69

Closed BertrandBordage closed 5 years ago

BertrandBordage commented 11 years ago

Today we have 3 markdown files in the repository. Originally, there was only the README.md written by @fogleman.

Though Markdown is excellent, simple and widely used, I prefer using reStructuredText. It has some defaults that Markdown has not (for example double ` for variables), but it is more complete, written for Python and it is the language of the Sphinx documentation generator.

What do you prefer?

ronmurphy commented 11 years ago

As how I know nothing of this, I should not be giving my thoughts, but if it is wrote for Python (be cause we are using it...) then why not use it? Or would this have no impact on the code?

BertrandBordage commented 11 years ago

No, it has no impact on the code. It's only a documentation decision. I don't know if we want much documentation and an API reference. If so, reStructuredText is mandatory. Otherwise, anything would do the job.