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

[Feature Request] Parent object documenation #15

Open
sparqueur opened this issue Oct 2, 2020 · 0 comments
Open

[Feature Request] Parent object documenation #15

sparqueur opened this issue Oct 2, 2020 · 0 comments

Comments

@sparqueur
Copy link

In some cases it is useful to add some documenation at 2 diffent levels. Example :

# Bla bla about persistence
persistence:
  # Enable / disable persistence
  enabled: true

Currently, you can't have both comments. Using the +doc-gen:break tag which is nice to get persistence comment but you won't get sub attributes description.

Do you think it might be possible to add both :

parameter Description Default
persistence Bla bla about persistence { enabled: true }
persistence.enbaled Enable / disable persistence true

Moreover, in order to have shorter values.yaml files, it is common to add inline comments. Do you think you could handle it ?

# Bla bla about persistence
persistence:
  enabled: true  # Enable / disable persistence
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant