Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Overhaul docstring formatting for consistency #695

Open
DerGuteMoritz opened this issue Nov 9, 2023 · 2 comments
Open

Overhaul docstring formatting for consistency #695

DerGuteMoritz opened this issue Nov 9, 2023 · 2 comments
Labels
easy Difficulty in resolving the problem good first issue A good issue for newcomers

Comments

@DerGuteMoritz
Copy link
Collaborator

Docstrings are not consistently formatted. For example, option docstrings are sometimes are full sentences (or even multiple sentences) while other times they are just fragmental and lowercased subphrases. Optionality and defaults are also not consistently formatted. There's probably more.
@DerGuteMoritz DerGuteMoritz mentioned this issue Nov 9, 2023
Merged
@KingMob KingMob added good first issue A good issue for newcomers easy Difficulty in resolving the problem labels Nov 14, 2023
@anabasalo
Copy link

@DerGuteMoritz @KingMob is this issue still happenning?
if so, can i solve it?
tks

@KingMob
Copy link
Collaborator

KingMob commented Mar 13, 2024

Sure! In particular, it would be great if all formatted options were in a table that cljdoc.org displays properly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
easy Difficulty in resolving the problem good first issue A good issue for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@DerGuteMoritz @KingMob @anabasalo