dvc: rename "working tree" to "workspace" #3914
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Suor
reviewed
Jun 1, 2020
|
|
||
| if revs and "working tree" in revs: | ||
| revs.remove("working tree") | ||
| if revs and "workspace" in revs: |
There was a problem hiding this comment.
There actually can be a tag or branch named workspace so this is no longer safe.
There was a problem hiding this comment.
This will also clash in many other places like plots and metrics.
There was a problem hiding this comment.
@Suor, is there any need for workspace in revs check at all?
EDIT: Looks like we ourselves add workspace on revs. We could instead make it a flag.
There was a problem hiding this comment.
Making it a flag won't fix output.
|
Docs updated in iterative/dvc.org@c73f7c0 |
shcheklein
pushed a commit
to iterative/dvc.org
that referenced
this pull request
Jun 11, 2020
* cmd ref: add note that move creates dirs * cmd ref: improve structure of add ref desc. * grammar: add some commas * term: checksum -> hash value in dvcignore guide * style: lower case bullet text * cmd ref: remove some redundancy in metrics index * cmd ref: update plots refs synopsis and descriptions per iterative/dvc/issues/3924 et al. * Add plots modify cmd * typo: CSV->csv * term: working tree -> workspace per iterative/dvc/pull/3914 * cmd ref: couple improvements to add ref per #1382 (review) and #1382 (review) * Update config/prismjs/dvc-commands.js * cmd ref: update plots modify description * cmd ref: add plots modify to nav, with a few more improvements * cmd ref: plots --show-json -> --show-vega per iterative/dvc#3891 (comment) * rename x-lab to x-label * cmd ref: review descriptions of plots index, show, and diff * cmd ref: review and update old plots cmds options per iterative/dvc#3948 et al. * cmd ref: a couple more option updates per #1382 (review) * cmd ref: emphasize add works with any large file/dir per #1382 (review) * cmd ref: updae plots modify top half (definition, description) per #1382 (review) al. * cmd ref: improve all plot cmd option descriptions * Update content/docs/command-reference/plots/modify.md * cmd ref: review examples (mainly images) in plots modify per #1382 (comment) et al. * cmd ref: rephrase info about how data arrays are injected to plot templates per #1382 (review) * cmd ref: update info on how targets for for plots show/diff per #1382 (review) * cmd ref: double check all plots examples per #1382 (comment) * cmd ref: remove info about plots show --select * cmd ref: update add desc per #1382 (review) * cmd ref: re-explain dvc add for dirs per #1382 (review) * cmd ref: improve description about targets in plots diff per #1382 (review) * cmd ref: make emoji note in plots index per #1382 (review) * cmd ref: remove ineffective CSV code block highlighting from plots refs per #1382 (review) * get started: improve intro in index * glossary: remove external deps entry (no need) * cmd ref: add info about column indexing for headerless tables per #1382 (comment) * cmd ref: update template metavar for plots subcommands per #1382 (review) * cmd ref: mention YAML is supported for plots per #1382 (comment) * cmd ref: rename template metavar again in plots per #1382 (comment) * cmd ref: clarify plots modify --no-csv-header per #1382 (review) * cmd ref: add note about plots modify in show and diff * cmd ref: update all plots options again * cmd ref: more updates to plots et al. per Ivan's review * cmd ref: multiple plots diff --targets allowed * cmd ref: update note about detault metrics in index per #1382 (review) * cmd ref: emphasize add --recursive is rarely needed per #1382 (review) * cmd ref: plots diff: update revisions arg desc per #1382 (review) * cmd ref: mention column names and numbers in plots {cmd} -x and -y per #1382 (review) * cmd ref: emphasize that metrics diff is not a real diff per #1382 (review) * cmd ref: simplify note on plots targets per #1382 (review) * cmd ref: how to id colmns in plots modify --no-csv-header per #1382 (review) * cmd ref: add default target behavior to plots show and diff rel: #1382 (review) * cmd ref: rename plots option --no-header per iterative/dvc/pull/4001 * cmd ref: term: prop->property (plots) per #1382 (comment) * cmd ref: more details on metrics index per #1382 (review) and #1382 (review) * cmd ref: more details on plots index per #1382 (review) and #1382 (review) * cmd ref: note about disply props in plots modify per #1382 (review) and #1382 (review) Co-authored-by: Dmitry Petrov <[email protected]>
shcheklein
pushed a commit
to iterative/dvc.org
that referenced
this pull request
Jun 11, 2020
* cmd ref: add note that move creates dirs * cmd ref: improve structure of add ref desc. * grammar: add some commas * term: checksum -> hash value in dvcignore guide * style: lower case bullet text * cmd ref: remove some redundancy in metrics index * cmd ref: update plots refs synopsis and descriptions per iterative/dvc/issues/3924 et al. * Add plots modify cmd * typo: CSV->csv * term: working tree -> workspace per iterative/dvc/pull/3914 * cmd ref: couple improvements to add ref per #1382 (review) and #1382 (review) * Update config/prismjs/dvc-commands.js * cmd ref: update plots modify description * cmd ref: add plots modify to nav, with a few more improvements * cmd ref: plots --show-json -> --show-vega per iterative/dvc#3891 (comment) * rename x-lab to x-label * cmd ref: review descriptions of plots index, show, and diff * cmd ref: review and update old plots cmds options per iterative/dvc#3948 et al. * cmd ref: a couple more option updates per #1382 (review) * cmd ref: emphasize add works with any large file/dir per #1382 (review) * cmd ref: updae plots modify top half (definition, description) per #1382 (review) al. * cmd ref: improve all plot cmd option descriptions * Update content/docs/command-reference/plots/modify.md * cmd ref: review examples (mainly images) in plots modify per #1382 (comment) et al. * cmd ref: rephrase info about how data arrays are injected to plot templates per #1382 (review) * cmd ref: update info on how targets for for plots show/diff per #1382 (review) * cmd ref: double check all plots examples per #1382 (comment) * cmd ref: remove info about plots show --select * cmd ref: update add desc per #1382 (review) * cmd ref: re-explain dvc add for dirs per #1382 (review) * cmd ref: improve description about targets in plots diff per #1382 (review) * cmd ref: make emoji note in plots index per #1382 (review) * cmd ref: remove ineffective CSV code block highlighting from plots refs per #1382 (review) * get started: improve intro in index * glossary: remove external deps entry (no need) * cmd ref: update add for 1.0 (1) up to... before Examples * cmd ref: 1.0 updates for add (2) - examples * cmd ref: remove note about comments in add example per #1411 (review) Co-authored-by: Dmitry Petrov <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #3892
❗ I have followed the Contributing to DVC checklist.
📖 If this PR requires documentation updates, I have created a separate PR (or issue, at least) in dvc.org and linked it here. If the CLI API is changed, I have updated tab completion scripts.
There are only two occurrences of
working treein docs:neither of those need to be changed right now.
Thank you for the contribution - we'll try to review it as soon as possible. 🙏