question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

code snippets in documentation not available on Github

See original GitHub issue

DVC documentation contains many examples that refer to some code snippets, such as dvc run \ -d prepare.py -d data.xml \ -o data.tsv -o data-test.tsv \ python prepare.py data.xml

But the file prepare.py can’t be found on its Github repo. It would be very helpful for users to understand how the code snippets were written so that can be used in ‘dvc run’.

Hope all the “*.py” files or other code examples would be available in Git repo. Thanks for the great work!

Richard

Issue Analytics

  • State:closed
  • Created 5 years ago
  • Comments:8 (5 by maintainers)

github_iconTop GitHub Comments

2reactions
robogeekcommented, Mar 7, 2019

I am currently going through the DVC commands and updating the documentation. Thank you for the feedback.

Generally speaking for now think of these as examples of what can be done, rather than precisely replicatable things.

I certainly get that you want replicatable examples, and will keep this in mind.

1reaction
richardxycommented, Mar 7, 2019

btw, I really like the tutorial https://dvc.org/doc/tutorial/define-ml-pipeline, which has the code downloadable from S3. Even so, it would be still nice to be able to read the code files on Github without downloading and unzipping the code package.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Creating and highlighting code blocks - GitHub Docs
Share samples of code with fenced code blocks and enabling syntax highlighting.
Read more >
Creating a permanent link to a code snippet - GitHub Docs
To link to code from a pull request, navigate to the pull request and click Files changed. Then, browse to the file that...
Read more >
Coloured syntax highlighting missing in code snippets ...
</CODE></PRE> and to add <BR> between lines of code where a newline was desired. However it does not colour the code based on...
Read more >
Code snippet "Choice" feature no longer working #144362
I have confirmed this worked in the previous version (1.63.2). Documentation I found shows this, so I believe I am doing correctly: User...
Read more >
"Code Block" on GitHub Pages is not rendering and throws an ...
I am trying to teach myself the finer points of GitHub pages by cloning an existing documentation repository and then mess with it...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found