search

oicr-gsi / robust-paper

Ten Simple Rules for Making Research Software More Robust. Manuscript is published at PLoS Computational Biology. Feedback is welcome!
https://doi.org/10.1371/journal.pcbi.1005412
MIT License
12 stars 0 forks source link

Shrink documentation rule #50

Closed morgantaschuk closed 7 years ago

morgantaschuk commented 7 years ago

I changed the lists from \describe to \enumerate and \ruleminor to an \textit, chopped words and examples and explanations and expansions of thought without regard for decency or nostalgia. And about halved the word count for the rule, from ~800 to ~450 words.

gvwilson commented 7 years ago

+1 to enumerate instead of description; would you be OK with keeping \ruleminor and having it render as \textit? Having something we define makes search and extraction a lot easier. And thank you for your ruthlessness w.r.t. word count - Dr. Prolixity has long been my nemesis...

gvwilson commented 7 years ago

Sorry, wasn't reading the diff properly - looks good to me. I've got a couple of other minor fixes to get in today (hopefully before noon).