helm-docs icon indicating copy to clipboard operation
helm-docs copied to clipboard

Output docs for values that are commented out

Open JakeSCahill opened this issue 2 years ago • 4 comments

How do I get this tool to output values that are commented out? For example:

# -- To use a custom pre-installed Issuer, add its name and kind here.
# issuerRef:
#   name: redpanda-default-root-issuer
#   kind: Issuer   # Can be Issuer or ClusterIssuer

JakeSCahill avatar Mar 28 '23 17:03 JakeSCahill

Do you want to make it output the values as if they are not commented out? Not sure if it's currently possible.

Nepo26 avatar Jun 29 '23 12:06 Nepo26

Ideally, yes. If it’s not currently possible, it’d be great to add this as a feature request

JakeSCahill avatar Jun 29 '23 12:06 JakeSCahill

I will add it as a feature request.

Sorry for the late reply. The repo was abandoned and we're getting it on track again right now.


How do you propose that we do it? As there is need for some people to include the commented out code as description for other parts. Maybe some flag or categorize it as disabled or deprecated?

Nepo26 avatar Jun 29 '23 13:06 Nepo26

No worries, thanks!

Maybe you could parse for comments such as:

# @include
# --description of the commented value
# some-commented-key: value

JakeSCahill avatar Jun 29 '23 13:06 JakeSCahill