Add enum notes #1750
Merged
Add enum notes #1750
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The example in the enum extensions sections of the docs needs to have `--enum` specified on the command line to generate as expected, so I added a note for that so future developers aren't as confused as I was.
|
kerwanp
pushed a commit
to kerwanp/openapi-typescript
that referenced
this pull request
Jul 29, 2024
The example in the enum extensions sections of the docs needs to have `--enum` specified on the command line to generate as expected, so I added a note for that so future developers aren't as confused as I was.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes
The example in the enum extensions sections of the docs needs to have
--enumspecified on the command line to generate as expected, so I added a note for that so future developers aren't as confused as I was.How to Review
This is a docs-only change, not much to review.
Checklist
docs/updated (if necessary)pnpm run update:examplesrun (only applicable for openapi-typescript) (n/a)