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

Expand documentation for the catalog function with integration examples #40

Open
paarthenon opened this issue Jul 15, 2022 · 0 comments
Open

Expand documentation for the catalog function with integration examples #40

paarthenon opened this issue Jul 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@paarthenon
Copy link
Owner

The catalog function is documented, but only its behavior. Ideally it should also show:

  1. How to use a pre-existing catalog as the basis for a variant's keys. This can be done manually, and likely also with the augment() function.
  2. Why TS's enum implementation is sort of problematic. It's ostensibly opaque, but that opaqueness can be leaky in a way that makes working with string literals the more honest way to go about things.
@paarthenon paarthenon added the documentation Improvements or additions to documentation label Jul 15, 2022
@paarthenon paarthenon added help wanted Extra attention is needed good first issue Good for newcomers labels Oct 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@paarthenon