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.

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

Structured API documentation #48

Open
bennn opened this issue Oct 15, 2024 · 0 comments
Open

Structured API documentation #48

bennn opened this issue Oct 15, 2024 · 0 comments

Comments

@bennn
Copy link
Member

bennn commented Oct 15, 2024

For now, the TrackedFloats documentation is simply the README:
https://github.com/utahplt/TrackedFloats.jl/blob/main/README.md

Add structured Julia-style documentation. Examples:
https://docs.juliaplots.org/stable/
https://paralab.github.io/Finch/dev/

Several TrackedFloat functions & datatypes already have documentation as comments, to start from:
https://github.com/utahplt/TrackedFloats.jl/blob/main/src/Config.jl

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant