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

term: don't use "take X under control" phrase #719

Closed
jorgeorpinel opened this issue Oct 21, 2019 · 6 comments · Fixed by #993
Closed

term: don't use "take X under control" phrase #719

jorgeorpinel opened this issue Oct 21, 2019 · 6 comments · Fixed by #993
Labels
A: docs Area: user documentation (gatsby-theme-iterative) good first issue Good for newcomers type: enhancement Something is not clear, small updates, improvement suggestions

Comments

@jorgeorpinel
Copy link
Contributor

jorgeorpinel commented Oct 21, 2019

Starting with https://dvc.org/doc/command-reference/add, per iterative/dvc#2546 (comment) (look at resolution there for final wording).

And look for any other instances.

@jorgeorpinel jorgeorpinel added type: enhancement Something is not clear, small updates, improvement suggestions A: docs Area: user documentation (gatsby-theme-iterative) good first issue Good for newcomers labels Oct 21, 2019
@shcheklein
Copy link
Member

@jorgeorpinel does it sound that terrible? :)

@jorgeorpinel
Copy link
Contributor Author

I didn't think so at first also but looked it up and thought about it, and yes, I think it sounds incorrect.

@shcheklein
Copy link
Member

@jorgeorpinel could you elaborate please?

@jorgeorpinel
Copy link
Contributor Author

jorgeorpinel commented Oct 21, 2019

  1. "To take" already implies "in one's control" and typically refers to possession or physical objects.
    image

  2. "under control" is an idiomatic phrase that doesn't mean what we are trying to convery

image

and we are mixing these 2 confusions together in a single phrase. 😋

@shcheklein
Copy link
Member

@jorgeorpinel good points that hard for me to "feel". Waiting for good suggestions on how do we replace this :)

@jorgeorpinel
Copy link
Contributor Author

Yeah TBH it wasn't intuitive at first to me either.

I think just use the term "track" as in "tracked by DVC" is the easiest fix to this. See for example iterative/dvc#2546 (comment).

efiop pushed a commit to iterative/dvc that referenced this issue Oct 24, 2019
* some doc improvements

* add: intermediate progress

* update after rebase

* linting

* fix checksum progress cleanup by ensuring gc

* progress-aware logger.info

* re-fix checksum pbar closure

* multi-file add

* make stage.dump() less verbose.

TODO: check all instances of stage.dump and possibly make verbose

* decrease verbosity of checksum calculations

* leave dvc.add stats

* update/fix logger tests

* minor doc reword

Co-Authored-By: Ruslan Kuprieiev <[email protected]>

* tidy API target_;list => targets

- as per #2546 (comment)

* tidy RecursiveAddingWhileUsingFilename message duplication

- fixes #2546 (comment)

* minor logging uncomment

- fixes #2546 (comment)

* minor doc improvements

- #2546 (comment)
- #2546 (comment)

* tidy exception

- fixes #2546 (comment)

* minor doc update

- fixes https://github.com/iterative/dvc/pull/2546/files#r337294491
- related to iterative/dvc.org#719

* Adding => add

- fixes #2546 (comment)

* various review fixes

- minor comment as per
  #2546 (comment)
- revert warning style fix
  #2546 (comment)
- Abstract error consistency
  #2546 (comment)
- minor comment as per
  #2546 (comment)

* remove diabling progress option

- fixes #2546 (comment)
shcheklein pushed a commit that referenced this issue Feb 15, 2020
* cmd ref: add space after emoji
intro in https://github.com/iterative/dvc.org/pull/951/files

* term: under X control -> tracked by X (or similar) (1)
for #719

* term: under X control -> tracked by X (or similar) (2)
strings from core repo

* term: add to -> add with (DVC)

* cmd ref: update import -o behaviod explantation
per iterative/dvc/pull/3312
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) good first issue Good for newcomers type: enhancement Something is not clear, small updates, improvement suggestions
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants