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

Support linking to types rather than embedding for autodoc generation #985

Open
mattrunyon opened this issue Oct 31, 2024 · 0 comments
Open
Labels
enhancement New feature or request
Milestone

Comments

@mattrunyon
Copy link
Collaborator

Some types (like Color) are quite long union types. I can't preview the file as it would render on salmon currently, but based on the generated markdown, the entire type is embedded into the param table. For long types, this could be quite annoying to look at if the type makes a row in the API table take up a ton of extra space.

I think we should have a list of types that are always linked to instead of embedded. And possibly a way to configure the autodoc command to embed types on a case-by-case basis.

@mattrunyon mattrunyon added enhancement New feature or request triage labels Oct 31, 2024
@vbabich vbabich added this to the Backlog milestone Nov 5, 2024
@vbabich vbabich removed the triage label Nov 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants