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

Standardize formatting of doc comments #49

Open
pacmanifold opened this issue Nov 15, 2022 · 0 comments
Open

Standardize formatting of doc comments #49

pacmanifold opened this issue Nov 15, 2022 · 0 comments
Labels
enhancement New feature or request

Comments

@pacmanifold
Copy link
Contributor

We should follow the conventional formatting of doc comments as seen in core, e.g. here. Initial description without header, then h1 for arguments section, example section, etc.
@pacmanifold pacmanifold changed the title Clean up formatting of doc comments Standardize formatting of doc comments Nov 15, 2022
@apollo-sturdy apollo-sturdy added the enhancement New feature or request label Nov 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@apollo-sturdy @pacmanifold