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

chore: cargo docs #538

Open
Jon-Becker opened this issue Dec 16, 2024 · 0 comments · May be fixed by #549
Open

chore: cargo docs #538

Jon-Becker opened this issue Dec 16, 2024 · 0 comments · May be fixed by #549
Labels
A-docs Area: docs D-chore Difficulty: chore P-normal Priority: normal

Comments

@Jon-Becker
Copy link
Owner

  1. add docstrings to ALL external fns
  2. add doctests where applicable
  3. github action to auto-update https://docs.heimdall.rs
@Jon-Becker Jon-Becker added A-docs Area: docs D-chore Difficulty: chore P-normal Priority: normal labels Dec 16, 2024
@Jon-Becker Jon-Becker linked a pull request Jan 4, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: docs D-chore Difficulty: chore P-normal Priority: normal
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: documentation and linting overhaul Jon-Becker/heimdall-rs
1 participant
@Jon-Becker