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

Add specification/documentation comments #10

Open
1 of 5 tasks
WillBAnders opened this issue Sep 18, 2022 · 0 comments
Open
1 of 5 tasks

Add specification/documentation comments #10

WillBAnders opened this issue Sep 18, 2022 · 0 comments
Assignees
@WillBAnders
Labels
analyzer docs evaluator medium priority parser

Comments

@WillBAnders
Copy link
Contributor

WillBAnders commented Sep 18, 2022 •
edited
Loading

The current codebase is almost entirely undocumented, mainly relying on test cases to clarify expected behavior. This slows down both new features and refactors since they often affect these unstated assumptions, and also limit the ability for other contributors to understand the codebase as well.

This is a tracking issue covering the main parts of the repository. Documentation should be included for most functions, with a particular emphasis on the analyzer and environment (which currently have the most complexity).

  • Parser (including rough grammar)
  • Analyzer
  • Evaluator
  • Environment
  • Library (mainly refer to Kotlin/Java methods as needed)
@WillBAnders WillBAnders self-assigned this Sep 18, 2022
WillBAnders added a commit that referenced this issue Sep 21, 2022
@WillBAnders
Add documentation for lexer/parser classes (#10)
b54f234 
Mainly focused on documenting the Lexer/Parser abstraction (for others trying
to implement DSLs) and adding a baseline grammar for sanity checking. Also
includes some code renaming/reorganization to aid documentation.
WillBAnders added a commit that referenced this issue Feb 20, 2023
@WillBAnders
Add documentation for Analyzer Contexts (#10)
cdf69f0 
Most of these are reasonably straightforward, but documenting intended purpose
here is helpful particularly for trickier ones like JumpContext. Also cleans up
code style to help flow with documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@WillBAnders WillBAnders

Labels
analyzer docs evaluator medium priority parser
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@WillBAnders