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.

Sign up for GitHub

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

Jump to bottom

Annotations #7

Closed
varna opened this issue Jul 23, 2019 · 2 comments
Closed

Annotations #7

varna opened this issue Jul 23, 2019 · 2 comments

Comments

@varna
Copy link
Owner

varna commented Jul 23, 2019

Add more JSDoc and Typescript. After importing this lib into your code you shouldn't need to look at the documentation to use it. Annotations should be descriptive enough to make this lib "plug & play".
@varna
Copy link
Owner Author

varna commented Jul 24, 2019

I'll probably go with something like:

type MetricFormat = "m" | "g" | "l"

It would be nice if I could "describe" what each string means instead of having it repeated again. i.e. "t" - "Metric tonne".

image

@varna
Copy link
Owner Author

varna commented Jul 24, 2019

It seems momentjs does the same
image

varna added a commit that referenced this issue Jul 25, 2019
@varna
annotated unit keys, fixes #7
f2ddf79
@varna varna closed this as completed in 72d11de Jul 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@varna