Add support for passing TSdoc for the generated types #29
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.
Description 📖
This allows you to pass a doc string for the attribute:
Which translates into a TSDoc-compliant comment:
Background 📜
We're using
types_from_serializersto generate the types and docs for parts of our API. This will allow us to document the attributes that we expose.The Fix 🔨
Add a
docattribute to the types.Screenshots 📷