Hacker News new | ask | show | jobs
by j88439h84 2274 days 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.

2 comments

I 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

Markdown allows links.