Conventions around docstrings? #554
-
|
Should Coalton docstrings follow commonly used Common Lisp conventions? For example, UPPERCASE for parameter names and |
Beta Was this translation helpful? Give feedback.
Replies: 1 comment 2 replies
-
|
We try not to in the standard library. Coalton's stdlib docs get fed into a markdown generator, that only shows type signatures. See the docs here. Because parameter names aren't visible in type signatures we try not to reference them in docstrings. We do use backtics for types because those look pretty in markdown. |
Beta Was this translation helpful? Give feedback.
-
|
Do the |
Beta Was this translation helpful? Give feedback.
-
I say yes. |
Beta Was this translation helpful? Give feedback.
We try not to in the standard library. Coalton's stdlib docs get fed into a markdown generator, that only shows type signatures. See the docs here. Because parameter names aren't visible in type signatures we try not to reference them in docstrings.
We do use backtics for types because those look pretty in markdown.