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

Markdown generator: List output #1309

Open
lars-reimann opened this issue Jan 16, 2025 · 0 comments
Open

Markdown generator: List output #1309

lars-reimann opened this issue Jan 16, 2025 · 0 comments
Labels
documentation 📖 Improvements or additions to documentation

Comments

@lars-reimann
Copy link
Member

Is your feature request related to a problem?

The Markdown generator currently creates tables for parameters, results, etc. This does not work well with longer names.

Desired solution

Add an option to create lists instead, akin to mkdocstrings-python.

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

No response
@lars-reimann lars-reimann added the documentation 📖 Improvements or additions to documentation label Jan 16, 2025
@lars-reimann lars-reimann added this to DSL Jan 16, 2025
@github-project-automation github-project-automation bot moved this to Backlog in DSL Jan 16, 2025
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
Projects
DSL
Status: Backlog
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lars-reimann