Rewrite and update of dvc config command ref.
#331
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
- Makes it easier to read and understand; - Puts it into the new command-ref structure (e.g. `dvc fecth`) - Reorganizes and reformats the paragaphs
jorgeorpinel
changed the title
dvc config in prep. for new dvc cache... docsdvc config ref. in prep. for new dvc cache... docs
shcheklein
reviewed
May 14, 2019
shcheklein
reviewed
May 14, 2019
shcheklein
reviewed
May 14, 2019
|
|
||
| ### core | ||
|
|
||
| This is the main section with the general settings: |
There was a problem hiding this comment.
let's double check. I'm pretty sure that we now have a whole bunch of new options.
There was a problem hiding this comment.
There's tons of config sections listed in https://github.com/iterative/dvc/blob/7ceaf88c54c90d53e64c1af2fa78b5b9bd4667a0/dvc/config.py#L139-L274 but I don't know what they do. I'll ask on Discord.
There was a problem hiding this comment.
Added all core and cache options but still not finished with all the other sections. Will lyk
shcheklein
reviewed
May 14, 2019
shcheklein
requested changes
May 14, 2019
2 tasks
jorgeorpinel
changed the title
dvc config ref. in prep. for new dvc cache... docsdvc config ref (in prep for new dvc cache docs)
- Reorders te ### remote section under ### core; - Breaks up some long paragraphs; - Adds recommendation to use `cache.protected` for hardlink or symlink `cache.type`; - Adds propper > Note in `cache.protected` paragraph; - Fixes md errors in `cache.xxx` descriptions
|
The idea of splitting up the doc definitely makes sense although it's not like But lmk @shcheklein and I'll create an issue to split it up after this round is done (so I can get this one done and focus on other priorities for now). Thanks |
jorgeorpinel
changed the title
dvc config ref (in prep for new dvc cache docs)dvc config command ref.
- Exapanded on it in the `dvc config` cmd ref; - Clarified and added notes about it in the refs od `dvc checkout` and `dvc pull`
instead of "workinf directory" or "working space" were it makes most sense to standardize
Merged
1 task
1 task
|
@shcheklein I think this PR is ready for merge, please review. I also opened a new issue regarding splitting up this cmd ref: #340 |
shcheklein
reviewed
May 15, 2019
shcheklein
reviewed
May 15, 2019
shcheklein
approved these changes
May 15, 2019
efiop
pushed a commit
to iterative/dvc
that referenced
this pull request
May 24, 2019
…essage (#2003) * Document dvc.scm.git::Git::_get_diff_trees and shorten commit hashes in dvc.scm.git::Git::get_diff_trees * diff: Changes to dvc.scm.git so `dvc diff` outputs short SHAs - Docstring for Git class constructor - Renames self.git for self.repo throughout module (involves several test changes) - Better doc and logical refactor in Git._get_diff_trees - `dvc diff` now outputs short SHA strings (Git._get_diff_trees) - hard coded to 7 length str (involves some test changes in tests/func/test_diff.py) For #1902 * Undoes "Renames self.git for self.repo throughout module" introduced in 3d2dc83. * autocomplete: Brings scripts/completion/dvc.zsh up-to-date - Reorganizes commands in alphabetical order; - Updates the command dscriptions according to their current usage (-h) output; - Adds comments for MISSING command entries * Update scripts/completion/dvc.zsh Co-Authored-By: Ruslan Kuprieiev <[email protected]> * Update scripts/completion/dvc.zsh Co-Authored-By: Ruslan Kuprieiev <[email protected]> * Update scripts/completion/dvc.zsh Co-Authored-By: Ruslan Kuprieiev <[email protected]> * Update scripts/completion/dvc.zsh Co-Authored-By: Ruslan Kuprieiev <[email protected]> * autocomplete: Adds missing commands to Zsh script * cache: updates slow link type warning message (and test) in accordance with iterative/dvc.org#331 * Fixes accidental docstring rewrap per #2003 (comment) * Actually fixes accidental docstring rewrap... per #2003 (review) * Really fixes accidental docstring rewrap this time...
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.
No description provided.