Document behavior of generating destination path when copying #1498
Conversation
Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1498 +/- ##
==========================================
- Coverage 97.46% 97.27% -0.20%
==========================================
Files 48 48
Lines 4537 4543 +6
==========================================
- Hits 4422 4419 -3
- Misses 115 124 +9
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
There are formatting issues. Please run |
Head branch was pushed to by a user without write access
| ```python | ||
| from copier import run_copy | ||
| ```python | ||
| from copier import run_copy | ||
|
|
||
| # Create a project from a local path | ||
| run_copy("path/to/project/template", "path/to/destination") | ||
| # Create a project from a local path | ||
| run_copy("path/to/project/template", "path/to/destination") | ||
|
|
||
| # Or from a Git URL. | ||
| run_copy("https://github.com/copier-org/copier.git", "path/to/destination") | ||
| # Or from a Git URL. | ||
| run_copy("https://github.com/copier-org/copier.git", "path/to/destination") | ||
|
|
||
| # You can also use "gh:" as a shortcut of "https://github.com/" | ||
| run_copy("gh:copier-org/copier.git", "path/to/destination") | ||
| # You can also use "gh:" as a shortcut of "https://github.com/" | ||
| run_copy("gh:copier-org/copier.git", "path/to/destination") | ||
|
|
||
| # Or "gl:" as a shortcut of "https://gitlab.com/" | ||
| run_copy("gl:copier-org/copier.git", "path/to/destination") | ||
| ``` | ||
| # Or "gl:" as a shortcut of "https://gitlab.com/" | ||
| run_copy("gl:copier-org/copier.git", "path/to/destination") | ||
| ``` |
There was a problem hiding this comment.
I don't think these indentation changes are necessary.
| run_copy("gl:copier-org/copier.git", "path/to/destination") | ||
| ``` | ||
|
|
||
| If `path/to/destination` doesn't exist, Copier will create the directory. |
There was a problem hiding this comment.
I think you can just leave it documented in ˋgenerating.mdˋ. This way, the README is shorter. It's not something with so much importance so as to live in the README IMHO.
Documents #1497.