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

Documentation for class properties should be placed with the declaration, not the instantiation. #97

Closed
pixelzoom opened this issue Dec 15, 2021 · 2 comments

Comments

@pixelzoom
Copy link
Contributor

For #84

This is violated in every .ts file that I've inspected.

From https://github.com/phetsims/phet-info/blob/master/doc/typescript-conventions.md#documentation-for-class-properties:

Documentation for class properties should be placed with the declaration, not the instantiation. For example:

class Person {

  // First and last name, separated by a whitespace
  readonly name: string;

  constructor( name: string ) {
    this.name = name;
  }
}

@marlitas
Copy link
Contributor

marlitas commented Jan 4, 2023

Moved what appeared to me to be declarative documentation outside of the constructor. Ready for review from @chrisklus.

@marlitas marlitas removed their assignment Jan 4, 2023
marlitas added a commit to phetsims/counting-common that referenced this issue Jan 9, 2023
chrisklus added a commit that referenced this issue Jan 13, 2023
chrisklus added a commit to phetsims/number-suite-common that referenced this issue Jan 17, 2023
chrisklus added a commit to phetsims/counting-common that referenced this issue Jan 17, 2023
chrisklus added a commit to phetsims/make-a-ten that referenced this issue Jan 17, 2023
chrisklus added a commit to phetsims/number-compare that referenced this issue Jan 17, 2023
@chrisklus
Copy link
Contributor

Thanks @marlitas! review complete. any additional updates were committed above. Closing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants