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

Enums are not documented #49

Open
mcclure opened this issue Aug 31, 2021 · 0 comments
Open

Enums are not documented #49

mcclure opened this issue Aug 31, 2021 · 0 comments
Labels
feature-request Request for new features or functionality
Milestone

Comments

@mcclure
Copy link

mcclure commented Aug 31, 2021

The only documentation for this library appears to be the README. However, this documentation is incomplete. The README documentation references several "enum-type" types, such as SyntaxKind (an enum{}) or NodeType (a union type supporting seven strings). Without knowing the allowed values of these enums, the library is not usable.

Clicking around in the github repo, I found src/main.ts, an extremely readable file with comments documenting the entire interface including the enums. I was able to use this to write my code. However a less experienced coder might not think to look for documentation in the src/ folder.

Expected behavior

All items from src/main.ts should be included in the README documentation, including the enums.

@aeschli aeschli added the feature-request Request for new features or functionality label Oct 25, 2021
@aeschli aeschli added this to the Backlog milestone Oct 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for new features or functionality
Projects
None yet
Development

No branches or pull requests

2 participants