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

Document 'token' API with TSDoc. #101

Open
digisomni opened this issue Oct 4, 2021 · 2 comments
Open

Document 'token' API with TSDoc. #101

digisomni opened this issue Oct 4, 2021 · 2 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@digisomni
Copy link
Member

digisomni commented Oct 4, 2021

https://github.com/vircadia/Iamus/blob/master/docs/API-Tokens.md

Document this API within the code and try to ferry as much relevant information in.

@digisomni digisomni added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 5, 2021
@digisomni digisomni changed the title Add TSDoc to relevant areas of code Document 'token' API with TSDoc. Oct 23, 2021
@Misterblue
Copy link
Collaborator

not sure what this is requesting. Is the issue that the code doesn't have enough comments to make the token interactions clear?

@digisomni
Copy link
Member Author

Ah, I should open more issues but in essence I wanted to split up the tasks of documenting the APIs with inline comments into multiple pieces so it doesn't seem like some insurmountable task. Documenting each API is a good start.

In-code comments are best for things like this so changes are more likely to be reflected in documentation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants