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

chore: require docstring on public members #4645

Merged
merged 9 commits into from
Oct 28, 2019
Merged

Commits on Oct 23, 2019

  1. chore: require docstring on public members

    Many people (still) contribute PRs with undocumented members, or
    undocumented classes, or undocumented defaults, because there is no tool
    support to check they're not forgetting.
    
    We used to have `@default` checking on props types for L2s, but not for
    interfaces that are used INSIDE L2 props structs, or that are used as
    props types for non-constructs.
    
    Add two new checks:
    
    * Requirement to document top-level types and public members.
    * Requirement to supply `@default` for optional properties on structs.
    
    Which supersede the previous one.
    
    Obviously, we have many currently undocumented APIs which are added
    to the ignore list.
    
    Fixes #2286.
    rix0rrr committed Oct 23, 2019
    Configuration menu
    Copy the full SHA
    a0b8137 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    03b8be6 View commit details
    Browse the repository at this point in the history

Commits on Oct 25, 2019

  1. Configuration menu
    Copy the full SHA
    77c8704 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    d13bc6a View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    39ddb03 View commit details
    Browse the repository at this point in the history

Commits on Oct 28, 2019

  1. More undefaulted props

    rix0rrr committed Oct 28, 2019
    Configuration menu
    Copy the full SHA
    a93d911 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    1152639 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    c57dbd2 View commit details
    Browse the repository at this point in the history
  4. Configuration menu
    Copy the full SHA
    a10eaed View commit details
    Browse the repository at this point in the history