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

Fix jsdoc comment for UNITS #94

Merged
merged 3 commits into from
Oct 8, 2020
Merged

Fix jsdoc comment for UNITS #94

merged 3 commits into from
Oct 8, 2020

Conversation

felix-kaestner
Copy link
Contributor

@felix-kaestner felix-kaestner commented Oct 8, 2020

Currently, the UNITS constant is not exported in the TypeScript declaration file since it is not annotated with the appropriate jsdoc comment. This Pull Request adds the jsdoc comment to fix the problem.

import {UNITS} from 'h3-js' // Error: Module '"h3-js"' has no exported member 'UNITS'.ts (2305)

Currently, the UNITS constant is not exported in the TypeScript declaration file since it is not annotated with the appropriate jsdoc comment.
@CLAassistant
Copy link

CLAassistant commented Oct 8, 2020

CLA assistant check
All committers have signed the CLA.

@coveralls
Copy link

coveralls commented Oct 8, 2020

Pull Request Test Coverage Report for Build 192

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 100.0%

Totals Coverage Status
Change from base Build 184: 0.0%
Covered Lines: 363
Relevant Lines: 363

💛 - Coveralls

Copy link
Collaborator

@nrabinowitz nrabinowitz left a comment

Choose a reason for hiding this comment

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

Looks great - thanks for the contribution!

* @property {string} m
* @property {string} km
* @property {string} m2
* @property {string} km2
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wish there was a way to read this directly from the code, but I guess that's a limitation of the JSDoc-driven type defs 🤷‍♂️

@nrabinowitz nrabinowitz merged commit 93f20eb into uber:master Oct 8, 2020
@felix-kaestner felix-kaestner deleted the patch-1 branch October 8, 2020 17:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants