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

Add JSDoc for Parser module #70

Open
13 tasks
Tracked by #76
MajorLift opened this issue Nov 26, 2023 · 0 comments
Open
13 tasks
Tracked by #76

Add JSDoc for Parser module #70

MajorLift opened this issue Nov 26, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@MajorLift
Copy link
Collaborator

MajorLift commented Nov 26, 2023

As part of our initiative to overhaul documentation for this library, we need JSDoc comments to be written for the following Object module methods, so that they can be automatically published using TypeDoc and GitHub Pages.

  • Choice
  • Letter
  • Letters
  • Many1
  • Map
  • ObjectSequence
  • Optional
  • Parser
  • Run
  • Sequence
  • State
  • String
  • TakeSequence

The JSDoc comments must adhere to the guidelines laid out in style-guide/jsdoc.md.

Here are two previous examples where the style guide was fed to an AI assistant to successfully generate documentation in JSDoc format.

@MajorLift MajorLift added the documentation Improvements or additions to documentation label Nov 26, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant