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

docs: simplify run examples, leaving bare min. usage #1700

Closed
jorgeorpinel opened this issue Aug 15, 2020 · 2 comments
Closed

docs: simplify run examples, leaving bare min. usage #1700

jorgeorpinel opened this issue Aug 15, 2020 · 2 comments
Labels
A: docs Area: user documentation (gatsby-theme-iterative) help wanted Contributors especially welcome type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Aug 15, 2020

Extracted from https://peckofpickledpojos.wordpress.com/2020/08/09/learning-dvc-by-trial-and-error:

the way stages are run assumes that the script src/prepare.py takes in command line arguments [incorrect but all of our examples look this way]... took me a few seconds before I could parse out what was happening

For example the first run example in https://dvc.org/doc/start/data-pipelines could just use python src/prepare.py as command and avoid repeating the dependency to avoid confusion. Probably other simplifications can be done to show the gist of run there and in other very-first examples of run users might find.

@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions help wanted Contributors especially welcome A: docs Area: user documentation (gatsby-theme-iterative) labels Aug 15, 2020
@jorgeorpinel jorgeorpinel changed the title run: add some simplified commands with bar min. usage (commands without args) run: add some simplified commands with bare min. usage (commands without args) Aug 15, 2020
@jorgeorpinel jorgeorpinel changed the title run: add some simplified commands with bare min. usage (commands without args) run: simplify intro. examples leaving bare min. usage Aug 15, 2020
@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Dec 8, 2020

Actually https://github.com/iterative/example-get-started/blob/master/src/prepare.py#L20 does take an argument from terminal.

Should we close this @shcheklein? Or change the example project so we don't have to repeat dependencies in run?

@jorgeorpinel jorgeorpinel changed the title run: simplify intro. examples leaving bare min. usage run: simplify basic examples t/o docs, leaving only bare min. usage Jan 6, 2021
@jorgeorpinel jorgeorpinel changed the title run: simplify basic examples t/o docs, leaving only bare min. usage run: simplify basic examples t/o docs, leaving bare min. usage Jan 6, 2021
@jorgeorpinel
Copy link
Contributor Author

Closed by #2075.

@jorgeorpinel jorgeorpinel changed the title run: simplify basic examples t/o docs, leaving bare min. usage docs: simplify run examples, leaving bare min. usage Sep 27, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A: docs Area: user documentation (gatsby-theme-iterative) help wanted Contributors especially welcome type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

No branches or pull requests

1 participant