chore: Add some docs to the frontend #903
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jfecher
commented
Feb 23, 2023
TomAFrench
reviewed
Feb 23, 2023
kevaundray
reviewed
Feb 24, 2023
6 tasks
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
|
Looks like the Keyword::iter change is failing the CI |
|
I'm not sure why tbh as it passed in its own PR. Will take a little look. |
TomAFrench
reviewed
Feb 24, 2023
Co-authored-by: Tom French <15848336+TomAFrench@users.noreply.github.com>
kevaundray
reviewed
Feb 24, 2023
kevaundray
reviewed
Feb 24, 2023
kevaundray
reviewed
Feb 24, 2023
kevaundray
reviewed
Feb 24, 2023
kevaundray
reviewed
Feb 24, 2023
kevaundray
previously approved these changes
Feb 24, 2023
TomAFrench
approved these changes
Feb 28, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related issue(s)
(none)
Description
Summary of changes
Adds some code documentation to the lexer, parser, node interner, and lib.rs files in the frontend.
This is the first part of several PRs to add documentation. I figured they'd be easier to review if I split them up rather than gave a single larger PR.
All changes in this PR are either adding comments or reordering code slightly so that the most important thing in a module is defined first. This later point is to make it easier for readers to find what a module does without having to skip past more unnecessary definitions.