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

Clean up API docs for stable modules #48

Open
epatters opened this issue Sep 28, 2019 · 0 comments
Open

Clean up API docs for stable modules #48

epatters opened this issue Sep 28, 2019 · 0 comments
Labels
docs good first issue

Comments

@epatters
Copy link
Member

epatters commented Sep 28, 2019 •
edited

Certain modules, such as for wiring diagrams, are approaching a reasonable degree of API stability. It would be good to improve the API docs. This means following the Julia docstring conventions and using Documenter.jl features such as @ref and @id, which I have not been consistently doing.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs good first issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@epatters