Skip to content

Commit 126c1a6

Browse files
committed
docs(CHANGES): Note Repo -> Project name change
1 parent bf5985b commit 126c1a6

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

CHANGES

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,19 +15,21 @@ $ pip install --user --upgrade --pre libvcs
1515

1616
### Breaking
1717

18-
- `GitRepo`, `SVNRepo`, `MercurialRepo`, `BaseRepo` have been moved to
19-
`libvcs.projects.{module}.{Module}Repo`
18+
- `GitRepo`, `SVNRepo`, `MercurialRepo`, `BaseRepo` have been renamed to
19+
`GitProject`, `SVNProject`, `MercurialProject`, `BaseProject` ({issue}`#327`)
20+
- `GitProject`, `SVNProject`, `MercurialProject`, `BaseProject` have been moved to
21+
`libvcs.projects.{module}.{Module}Project`
2022
- `repo_dir` param is renamed to `dir`:
2123

22-
Before: `GitRepo(url='...', repo_dir='...')`
24+
Before: `GitProject(url='...', repo_dir='...')`
2325

24-
After: `GitRepo(url='...', dir='...')`
26+
After: `GitProject(url='...', dir='...')`
2527

2628
{issue}`#324`
2729

28-
- `dir` to `pathlib`, `BaseRepo.path` -> `BaseRepo.dir`
29-
- Logging functions moved to {attr}`libvcs.projects.base.BaseRepo.log` ({issue}`#322`)
30-
- Rename `RepoLoggingAdapter` to `CmdLoggingAdapter`
30+
- `dir` to `pathlib`, `BaseProject.path` -> `BaseProject.dir`
31+
- Logging functions moved to {attr}`libvcs.projects.base.BaseProject.log` ({issue}`#322`)
32+
- Rename `ProjectLoggingAdapter` to `CmdLoggingAdapter`
3133
- `CmdLoggingAdapter`: Rename `repo_name` param to `keyword`
3234

3335
### What's new
@@ -51,10 +53,10 @@ $ pip install --user --upgrade --pre libvcs
5153
- {meth}`libvcs.cmd.hg.Hg.run`
5254
- {meth}`libvcs.cmd.hg.Hg.clone`
5355

54-
- {class}`libvcs.projects.git.GitRepo` now accepts remotes in `__init__`
56+
- {class}`libvcs.projects.git.GitProject` now accepts remotes in `__init__`
5557

5658
```python
57-
repo = GitRepo(
59+
repo = GitProject(
5860
url="https://github.com/vcs-python/libvcs",
5961
repo_dir=checkout,
6062
remotes={
@@ -64,7 +66,7 @@ $ pip install --user --upgrade --pre libvcs
6466
```
6567

6668
```python
67-
repo = GitRepo(
69+
repo = GitProject(
6870
url="https://github.com/vcs-python/libvcs",
6971
repo_dir=checkout,
7072
remotes={
@@ -76,7 +78,7 @@ $ pip install --user --upgrade --pre libvcs
7678
)
7779
```
7880

79-
- {meth}`libvcs.projects.git.GitRepo.update_repo` now accepts `set_remotes=True`
81+
- {meth}`libvcs.projects.git.GitProject.update_repo` now accepts `set_remotes=True`
8082

8183
### Compatibility
8284

0 commit comments

Comments
 (0)