Skip to content

Commit bf77c80

Browse files
committed
CHANGES(docs): Document breaking API changes for 0.39.x (#507)
why: Users need migration guidance for renamed parameters and methods. what: - Add Breaking changes section for API naming consistency - Document all _all parameter renamings in cmd/git.py - Document remotes() and remote() renames in sync/git.py - Include migration examples with before/after code
1 parent 11ccfea commit bf77c80

File tree

1 file changed

+42
-1
lines changed

1 file changed

+42
-1
lines changed

CHANGES

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,48 @@ $ uv add libvcs --prerelease allow
1818

1919
<!-- Maintainers, insert changes / features for the next release here -->
2020

21-
_Upcoming changes will be written here._
21+
### Breaking changes
22+
23+
#### API Naming Consistency
24+
25+
Renamed parameters and methods to follow Python community conventions (Django, pytest, Sphinx patterns).
26+
27+
**cmd/git.py: Renamed `_all` parameters to descriptive names:**
28+
29+
| Method | Old Parameter | New Parameter |
30+
|--------|---------------|---------------|
31+
| `clone()` | `_all` | `all_branches` |
32+
| `fetch()` | `_all` | `all_remotes` |
33+
| `pull()` | `_all` | `all_remotes` |
34+
| `help()` | `_all` | `show_all` |
35+
| `rev_list()` | `_all` | `include_all_refs` |
36+
| `remote.get_url()` | `_all` | `all_urls` |
37+
| `stash.save()` | `_all` | `include_ignored` |
38+
| `stash.push()` | `_all` | `include_ignored` |
39+
| `branches.ls()` | `_all` | `all_branches` |
40+
41+
**sync/git.py: Renamed getter methods with `get_` prefix:**
42+
43+
| Old Method | New Method |
44+
|------------|------------|
45+
| `remotes()` | `get_remotes()` |
46+
| `remote(name)` | `get_remote(name)` |
47+
48+
**Migration example:**
49+
50+
```python
51+
# Before
52+
git.fetch(_all=True)
53+
git.stash.save(_all=True)
54+
repo.remotes()
55+
repo.remote("origin")
56+
57+
# After
58+
git.fetch(all_remotes=True)
59+
git.stash.save(include_ignored=True)
60+
repo.get_remotes()
61+
repo.get_remote("origin")
62+
```
2263

2364
### Development
2465

0 commit comments

Comments
 (0)