-
Notifications
You must be signed in to change notification settings - Fork 61
Open
Labels
feature-requestRequest for new features or functionalityRequest for new features or functionality
Milestone
Description
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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
feature-requestRequest for new features or functionalityRequest for new features or functionality