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

Keep leading spaces in descriptions #62

Open
jnodorp-jaconi opened this issue Mar 23, 2023 · 3 comments
Open

Keep leading spaces in descriptions #62

jnodorp-jaconi opened this issue Mar 23, 2023 · 3 comments
Assignees
Labels
on-hold Issues that we need to work on

Comments

@jnodorp-jaconi
Copy link

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` |
@fmulero fmulero self-assigned this Oct 20, 2023
@github-actions github-actions bot assigned fmulero and unassigned fmulero Nov 29, 2023
@fmulero
Copy link
Contributor

fmulero commented Mar 12, 2024

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 fmulero added the on-hold Issues that we need to work on label Mar 12, 2024
@viceice
Copy link

viceice commented Sep 12, 2024

This is a really anoying bug

@juanjo-vlc
Copy link

+1
Descriptions should be kept verbatim

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
on-hold Issues that we need to work on
Projects
None yet
Development

No branches or pull requests

4 participants