search

EmblemOfEa / Tenebrae

1 stars 0 forks source link

Standardized Markdown model for `__docstrings__` #3

Open taladan opened 6 years ago

taladan commented 6 years ago

I'm apt to just kind of put 'what looks good' up on the page (it's one of my failings) until I can get something standardized for separating different parts of a document. It's going to be important that we come up with a standard for the markdown used for documenting code because that's going to be the readme stuff that shows up on the page, as well as being able to easily work with the data/sections if they're tagged properly for processing. I don't have a particular favorite that I'm set on, so if one of you has a standard they work to or whatnot, I'll gladly take it and stick to it.

If someone wants to provide a template or a link to the template I can go ahead and start using it in my documentation so that re-formating won't be a pain.

EmblemOfEa commented 6 years ago

Markdown: https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet ?

taladan commented 6 years ago

I've been using that for learning MD. I was hoping to get a standard layout that looks good for our docstrings that are going to be displayed here on git to document the commands that we add. I'm open to any format, just wanted someone else's input instead of saying 'this is how we're going to do it' - my eye for what looks good may not be as good as y'all's.

And yes, there are two apostrophes in y'all's. I'm from the south. :dancing_men: