4 ms·
Yeah I don't fully get this whole anti-Markdown sentiment. Have I ever ran into limitations with Markdown? Yes. Has Markdown ever been the reason why things w
by kylepdm 7y ago
Yeah I don't fully get this whole anti-Markdown sentiment.
Have I ever ran into limitations with Markdown? Yes.
Has Markdown ever been the reason why things were poorly documented? No.
Whatever gets people to document stuff, and maintain and update that documentation.
- cl42 7y agoSeriously, “Please document you’re code in the first place” is a great post to promote! :)
- xtracto 7y ago*Your But yeah, that would be useful. These posts read like fluff to me... I was tempted to write a tongue in cheek post titled "Why it is a bad idea to use a butter knife to unscrew a slot screw". Markdown is a tool, it has some advantages and disadvantages, some people will misuse it, but if you can make it work for you, then that's great. It is just a tool.
- j88439h84 7y ago> Has Markdown ever been the reason why things were poorly documented? Yes. Anytime you see technical docs without structure or links to the functions and classes being discussed, it's because of Markdown.
- t-writescode 7y agoI just reference other functions by name. That’s usually enough. My coworkers and my future self are adults and can use ‘find’. edit: I do use more qualified names, though: className.methodName or filename.extension:function_name
- lonelappde 7y agoMarkdown allows links.