Skip to content

Broken indentation in indented code blocks #1509

Open

Description

@skshetry

Expand the section Expand to see what happens under the hood. on https://dvc.org/doc/start/data-pipelines#pipeline-stages. The params.yaml is incorrectly rendered (indentation that is).

https://github.com/iterative/dvc.org/blob/befb19b5debaf47137d3507e1be919640211cc78/content/docs/start/data-pipelines.md#L76-L80

It seems to be correctly written. Maybe something wrong with rendering it?

UPDATE See #1509 (comment)

  • Review all indented code blocks after this is solved.

Activity

  1. added
    help wantedContributors especially welcome
    p2-nice-to-haveLess of a priority at the moment. We don't usually deal with this immediately.
    on Jun 29, 2020
  2. shcheklein commented on Jun 29, 2020

    @shcheklein
    Contributor

    Fixed, had to un-indent the whole block for this to work. Weird. Will keep this as a doc engine bug.

    If yaml code block is indented to be under a bullet item rendering breaks.

  3. jorgeorpinel commented on Jul 1, 2020

    @jorgeorpinel
    Contributor

    That code block was correctly indented though, it's part of a bullet. Now it's uneven (compare to the next block):

    image

  4. shcheklein commented on Jul 1, 2020

    @shcheklein
    Contributor

    This is a temporary workaround. This engine bug.

  5. jorgeorpinel commented on May 10, 2021

    @jorgeorpinel
    Contributor

    I changed the workaround in #2458 so the block is rendered aligned.

  6. added
    p1-importantActive priorities to deal within next sprints
    and removed
    help wantedContributors especially welcome
    p2-nice-to-haveLess of a priority at the moment. We don't usually deal with this immediately.
    on May 10, 2021
  7. changed the title [-]yaml incorrectly rendered[/-] [+]broken indentation in indented code blocks[/+] on May 10, 2021
  8. jorgeorpinel commented on May 10, 2021

    @jorgeorpinel
    Contributor

    Expand the section Expand to see what happens under the hood. on https://dvc.org/doc/start/data-pipelines#pipeline-stages.

    BTW this also happens in the git block under that YAML block too:

    image

    So this probably applies to indentation with many all kinds of code blocks that are indented themselves.

    UPDATE: Another place where this if currently manifested is in the remote add/modify refs per-type sections. Some of them are using workarounds to render correctly, some others not.

  9. jorgeorpinel commented on May 10, 2021

    @jorgeorpinel
  10. rogermparent commented on May 10, 2021

    @rogermparent
  11. jorgeorpinel commented on May 10, 2021

    @jorgeorpinel
  12. added
    p2-nice-to-haveLess of a priority at the moment. We don't usually deal with this immediately.
    and removed
    p1-importantActive priorities to deal within next sprints
    on Jul 26, 2021
  13. removed
    p2-nice-to-haveLess of a priority at the moment. We don't usually deal with this immediately.
    on May 4, 2022
  14. changed the title [-]broken indentation in indented code blocks[/-] [+]Broken indentation in indented code blocks[/+] on May 4, 2022
  15. jorgeorpinel commented on May 4, 2022

    @jorgeorpinel
    Contributor

    Just a note that this is still a bug. Not a common thing we run into but the workaround (adding extra spaces) conflicts with the linter in some cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions