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.

Sign up for GitHub

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

start: code block indentation workarounds #2458

Closed
wants to merge 2 commits into from
Closed

start: code block indentation workarounds #2458

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b861023
start: workaround indent yaml block
jorgeorpinel May 9, 2021
0455be0
start: another indentation workaround
jorgeorpinel May 9, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions content/docs/start/data-pipelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,11 +90,11 @@ The command options used above mean the following:
but the idea is that the stage can depend on field values from a parameters
file (`params.yaml` by default):

```yaml
prepare:
split: 0.20
seed: 20170428
```
```yaml
prepare:
split: 0.20
seed: 20170428
```
Comment on lines -93 to +97
Copy link
Contributor Author

@jorgeorpinel jorgeorpinel May 10, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Had to force commit this since Pretty doesn't like it (4-space indentation). Formatting check will prob. fail. But this looks correctly for now:

image


- `-d src/prepare.py` and `-d data/data.xml` mean that the stage depends on
these files to work. Notice that the source code itself is marked as a
Expand All @@ -105,18 +105,18 @@ prepare:
two files in it. This is how the <abbr>workspace</abbr> should look like now:

```git
.
├── data
│ ├── data.xml
│ ├── data.xml.dvc
.
├── data
│ ├── data.xml
│ ├── data.xml.dvc
+│ └── prepared
+│ ├── test.tsv
Comment on lines 107 to 113
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here the workaround so it looks correct really makes the code looks broken. And the formatter doesn't catch this one. So I wonder if it's best to close this PR and focus on fixing #1509 instead.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

WDYT @shcheklein ?

BTW if so maybe I should remove all other workaround indentations that are currently in docs, e.g. in the remote modify ref there's several. Or we can do that after the bug is fixed (added a checkbox in that issue).

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be honest looks like a minor problem, I would wait on the engine to fix this, for now broken it's fine to unindent code blocks

+│ └── train.tsv
+├── dvc.yaml
+├── dvc.lock
├── params.yaml
└── src
├── ...
├── params.yaml
└── src
├── ...
```

- The last line, `python src/prepare.py ...`, is the command to run in this
Expand Down