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: Clean-up Documentation for Mapped SnakeCased Properties #1686

Open
danielbankhead opened this issue Oct 25, 2023 · 0 comments
Open

chore: Clean-up Documentation for Mapped SnakeCased Properties #1686

danielbankhead opened this issue Oct 25, 2023 · 0 comments
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: cleanup An internal cleanup or hygiene concern.

Comments

@danielbankhead
Copy link
Member

danielbankhead commented Oct 25, 2023

Today, we manually document mapped snakeCase'd keys in a number of places to improve ergonomics for customers manually instantiating AuthClients as of #1663.

At the time of writing, keys remapped via as do not pass the original keys' jsdoc, requiring us to manually write the documentation for each key. Once this has been resolved on the TypeScript side we should clean up the documentation and types throughout the library.

Implementation Notes:

  • Most places where this is a problem should reference this issue's id; it is best to start there.

Dependencies:

@danielbankhead danielbankhead added type: cleanup An internal cleanup or hygiene concern. priority: p3 Desirable enhancement or fix. May not be included in next release. labels Oct 25, 2023
@danielbankhead danielbankhead changed the title chore: Clean-up Documentation for Mapped SnakeCase'd Properties chore: Clean-up Documentation for Mapped SnakeCased Properties Oct 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: p3 Desirable enhancement or fix. May not be included in next release. type: cleanup An internal cleanup or hygiene concern.
Projects
None yet
Development

No branches or pull requests

1 participant