readme-generator-for-helm icon indicating copy to clipboard operation
readme-generator-for-helm copied to clipboard

Keep leading spaces in descriptions

Open jnodorp-jaconi opened this issue 2 years ago • 4 comments

Currently, leading spaces are removed, when a section description is generated. This is problematic for code sections:

README.md

## Parameters

values.yaml

## @section MRE

## @descriptionStart
## ```yaml
## foo:
##   bar: baz
## ```
## @descriptionEnd

## @param foo
foo: bar

Result

## Parameters

### MRE

```yaml
foo:
bar: baz
```

| Name  | Description | Value |
| ----- | ----------- | ----- |
| `foo` |             | `bar` |

Expected Result

## Parameters

### MRE

```yaml
foo:
  bar: baz
```

| Name  | Description | Value |
| ----- | ----------- | ----- |
| `foo` |             | `bar` |

jnodorp-jaconi avatar Mar 23 '23 07:03 jnodorp-jaconi

Sorry for my very late response

I've just created an internal task to work on this issue. I hope to come back soon.

fmulero avatar Mar 12 '24 09:03 fmulero

This is a really anoying bug

viceice avatar Sep 12 '24 10:09 viceice

+1 Descriptions should be kept verbatim

juanjo-vlc avatar Oct 02 '24 12:10 juanjo-vlc