Skip to content

dvcignore: initial description#263

Merged
shcheklein merged 2 commits into
treeverse:masterfrom
pared:248
Apr 29, 2019
Merged

dvcignore: initial description#263
shcheklein merged 2 commits into
treeverse:masterfrom
pared:248

Conversation

@pared
Copy link
Copy Markdown
Contributor

@pared pared commented Apr 22, 2019

Fixes #248
Related to treeverse/dvc#1820

Copy link
Copy Markdown
Contributor

@shcheklein shcheklein left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thaks @pared a lot!

When you have time, please take a look at the following improvements we can make:

  1. You need to register it in the src/Documentation/sidebar.json so that it's visible in the navigation panel.
  2. Should we name it as Git does - just dvcignore?
  3. Let's try to follow the same doc structure as we already have in commands reference. First one sentence on what it actually does. Then description (you already have it pretty much) .
  4. It's not actually clear from the description what is the current implementation doing. It describes the purpose but it's not clear what is it actually doing now.
  5. A simple example?
  6. Style - no trailing whitespaces

@shcheklein
Copy link
Copy Markdown
Contributor

Looks great, @pared . Thanks!

@shcheklein shcheklein merged commit 9025559 into treeverse:master Apr 29, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

dvcignore: document change

2 participants