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

docs: 📚 improve inline TypeScript docs #109

Merged
merged 3 commits into from
Nov 28, 2024
Merged

docs: 📚 improve inline TypeScript docs #109

merged 3 commits into from
Nov 28, 2024

Conversation

rodneylab
Copy link
Owner

Description

Improve inline TypeScript documentation to complement extensive docs already
included in README.md.

Type of change

  • Docs

How Has This Been Tested?

  • cargo test run with all tests passing
  • Deno tests run and passed

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@rodneylab rodneylab merged commit cfc8379 into main Nov 28, 2024
17 checks passed
@rodneylab rodneylab deleted the doc__improve_inline_docs branch November 28, 2024 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@rodneylab