Document the compat_seen function #528
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
Yes, I think it is very much okay to document things. :-) The 'Seen' trick is used in similar ways in various places, IIRC not only in compat. |
|
I also think it's good to document things 👍 On the other hand, I'm not sure we'll ever be able to document everything with this level of detail, since a typechecker is quite a dense piece of code with a lot of assumed background knowledge. The case of |
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.
I think I finally understand why we need to carry the
Seenvariable. 😄Oftentimes, I find the documentation of Gradualizer's codebase unsatisfactory and not very welcoming for newcomers (much useful information is just scattered in GitHub issues and pull requests). Is it okay to document things as I gradually (haha) become familiar with Gradualizer? Also, I'm better at concrete than abstract thinking, and examples help me a lot to understand things. Is it alright to include them in the docs?