search

McParen / croatoan

This repository has been migrated to Codeberg.
Other
147 stars 13 forks source link

Link to document #50

Closed contrapunctus-1 closed 1 year ago

McParen commented 1 year ago

Hello contrapunctus, thanks for the PR, but I have to ask, what is the point of enclosing names in the equals character? It does not make it easier to read the text, imho, in contrary. This is a highlighting style that is not used anywhere in the docstrings, so I do not think that it should be introduced here.

Regards, McP.

contrapunctus-1 commented 1 year ago

It's Org markup for verbatim output. I use it for identifiers and command line arguments, to make them visually distinct from the surrounding text. You can see its effects on the rendering here - https://github.com/contrapunctus-1/croatoan/tree/patch-1#introduction

I can remove it, if you like. Note that I've made similar PRs for the documentation of numerous projects, but this is the first time I've heard an objection to it.

McParen commented 1 year ago

Hello contrapunctus,

you are right, I for some reason overlooked the fact that it was an org file where you added the markup, I have mistaken it for code docstrings, where it obviously wouldnt add to readability. Sorry for the confusion.

McP.