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

Improvements to YAML example directive #47

Open
6 tasks
stevenbal opened this issue Jan 16, 2025 · 0 comments
Open
6 tasks

Improvements to YAML example directive #47

stevenbal opened this issue Jan 16, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@stevenbal
Copy link
Contributor

stevenbal commented Jan 16, 2025 •
edited
Loading

Remaining points from #35

  • polymorphic primitive values as comments after the first option (foo: bar # or 123)
  • display the type as well (only for primitives?)
  • newlines between attributes (after instead of before, seems difficult to get this working)
  • comment out non required fields? -> kind of difficult to implement
  • extra indent for comments -> does cause yaml errors in docs

lower prio:

  • check if docstrings of fields are picked up
@stevenbal stevenbal added documentation Improvements or additions to documentation enhancement New feature or request labels 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 enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@stevenbal