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

doc: document variables referencing schemas in code #174

Merged
merged 1 commit into from
Dec 6, 2023

Conversation

ChALkeR
Copy link
Contributor

@ChALkeR ChALkeR commented Nov 30, 2023

Let's merge this before #172.

@ChALkeR ChALkeR added the documentation Improvements or additions to documentation label Nov 30, 2023
@ChALkeR ChALkeR self-assigned this Nov 30, 2023
@codecov-commenter
Copy link

codecov-commenter commented Nov 30, 2023

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.54%. Comparing base (e3224b1) to head (faddd1e).
Report is 6 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
Files Coverage Δ
src/compile.js 99.29% <100.00%> (+<0.01%) ⬆️

Copy link

@mvayngrib mvayngrib left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK

maybe add JSDoc style comments to the relevant methods with those params/vars for better intellisense?

@ChALkeR
Copy link
Contributor Author

ChALkeR commented Nov 30, 2023

@mvayngrib the logic in this file is too complex for that to be useful, and extra churn would make this less readable so I fear it might end up net-negative.

E.g. there are a lot of arrow functions, and even visit() is one of them.

I'm thinking of a way to better document the logic there.

Copy link
Contributor

@sparten11740 sparten11740 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

utACK

@ChALkeR ChALkeR merged commit b549d02 into master Dec 6, 2023
10 checks passed
@RyanZim RyanZim deleted the chalker/codedoc/0 branch December 8, 2023 01:16
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

Successfully merging this pull request may close these issues.

4 participants