Update the linebreak symbol

[leehanchung]

The original doc comment of this is confusing for Python users:

$ mkdir data
$ dvc get https://github.com/iterative/dataset-registry \ 
get-started/data.xml -o data/data.xml

So changed this into one single command line for clarity after conversation with Ivan on Discord.

$ mkdir data
$ dvc get https://github.com/iterative/dataset-registry get-started/data.xml -o data/data.xml

IMPORTANT NOTES (please read, then delete):

• Have you followed the guidelines in
  Contributing Documentation?

• Please use the title to provide a clear one-line present-tense summary of the
  changes introduced in the PR. For example: "Introduce the first version of the
  collection editor.".

• Please make sure to mention "Fix #bugnum" (if applicable) in the description
  of the PR. This enables GitHub to link the PR to the corresponding bug.

[jorgeorpinel]

Thanks @leehanchung! Are you VitaminC on Discord? Haha

The reason we have \ after around 70 chars in many of our terminal samples is for better readability though. Otherwise the code blocks would scroll horizontally.

Fortunately we have #759 open that would solve this possible confusion for Windows users. Or if you have any other suggestions, feel free to reach out on Discord or GitHub issues.

[shcheklein]

@jorgeorpinel can we do this split before -o to reduce chances for mistake? It's not even about Windows users vs Linux - it's also about Python habits it looks like :)

[jorgeorpinel]

That would make the code not fit in the block, which would scroll, @shcheklein:

[shcheklein]

:( yeah, that URL is just too large

not sure though that Windows tabs is the solution for this problem

may be do dvc get -o data/data.xml URL PATH?

[jorgeorpinel]

That still needs \. Probably 2:

$ dvc get -o data/data.xml \
          https://github.com/iterative/dataset-registry \ 
          get-started/data.xml

And we have a bunch of \ break lines all around the docs.

[jorgeorpinel]

not sure though that Windows tabs is the solution for this problem

That should definitely solve this, as \ is not supported in cmd; So for Windows cmd code samples we would have to use long lines and a special code block that wraps lines, I guess. Or a horizontal scroll bar that is always shown so people don't miss the hidden part of the lines.

[leehanchung]

How about

dvc get https://github.com/\
iterative/dataset-registry  get-started/data.xml -o data/data.xml

Be mindful when copying the above command. Make sure there's a space between repo-url `https://github.com/iterative/dataset-registry` and `get-started/data.xml`. The usage is `dvc get` <repo-url> <repo-folder> -o <data to be pulled>

[jorgeorpinel]

Interesting. That looks super weird though.

I'm not sure adding the note just for some Windows users is a good idea. We would have to do this on every command sample with \ throughout the docs.

Sorry to sound so negative! I think the best solution is #759, which BTW is still on research phase, so it could well end up being an automatic platform detection mechanism that just adds these notes automatically. I think it's best to move this discussion to that issue.