Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
Add TS typings + build improvements #54
Add TS typings + build improvements #54
Changes from 6 commits
6827b77
c45b394
3e337a9
f37c223
aa251ac
b6a4216
9beb2fe
fe413c4
efa55c2
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
good catch! that line should be deleted. I recently made it public (i.e. exported it), so that I could test it: https://github.com/proj4js/mgrs/blob/master/test/test.js#L123
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, there's public, then there's public. If you don't think it warrants showing up on the public API I don't think there's any problem with leaving
@private
in the JSDoc. Typescript has an@internal
annotation that works in a similar way, that excludes it from generated typings.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's keep it the way that is now then. I'm worried about making the API more complicated without a clear use case. If a clear use case for people using getLetterDesignator comes up independent of forward or inverse, I'll change my mind :-)
Could you replace the TODO with
// hiding from the public API to keep things simple for users
or something to that effect?