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

docs(cache): add/change some comments for clarity #357

Merged
merged 1 commit into from
Jun 14, 2022

Commits on Jun 11, 2022

  1. docs(cache): add/change some comments for clarity

    - use typedoc for `isDirty` comment so that it actually appears in IDEs etc
      - and use `@returns` typedoc annotation for better specification
      - modify the comment a little for better grammar: 3 "or"s and no commas -> 1 "or" and commas
      - use more accurate terminology: "global types" -> "ambient types"
        - that's also more consistent in this codebase itself, where there's a legit function named `checkAmbientTypes`
    
    - in `init`, specify that the `RollingCache` error should never actually happen
      - I was a bit confused by when this would happen, then checked the constructor, and the answer is basically never: it's an invariant / redundant error-check
      - also add a new line for style consistency
    agilgur5 committed Jun 11, 2022
    Configuration menu
    Copy the full SHA
    b40d8fc View commit details
    Browse the repository at this point in the history