API Naming Consistency: Rename _all parameters and add get_ prefix to getters #507
Conversation
This file contains hidden or 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
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #507 +/- ##
==========================================
- Coverage 53.22% 53.18% -0.04%
==========================================
Files 38 38
Lines 5676 5676
Branches 1063 1063
==========================================
- Hits 3021 3019 -2
- Misses 2144 2145 +1
- Partials 511 512 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tony
added a commit
that referenced
this pull request
Dec 30, 2025
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
tony
added a commit
that referenced
this pull request
Dec 30, 2025
why: Users need detailed migration guidance when upgrading. what: - Document _all parameter renamings with before/after examples - Document remotes()/remote() getter method renames - Include tables showing old vs new parameter/method names
tony
force-pushed
the
api-renaming-getters
branch
2 times, most recently
from
c7e1f91 to
7ebe2ef
Compare
why: Document standard Python community patterns for API naming what: - Add get_* prefix convention for I/O methods - Document descriptive parameter naming over _all style - Include examples of good vs bad patterns - Reference Django/pytest/Sphinx as precedent
why: Follow Python community conventions (Django/pytest/Sphinx patterns) for clearer, more self-documenting APIs. what: - cmd/git.py: Rename _all parameters to descriptive names: - clone(_all) → all_branches - fetch(_all) → all_remotes - pull(_all) → all_remotes - help(_all) → show_all - rev_list(_all) → include_all_refs - get_url(_all) → all_urls - stash.save(_all) → include_ignored - stash.push(_all) → include_ignored - branch.ls(_all) → all_branches - sync/git.py: Add get_ prefix to getter methods: - remotes() → get_remotes() - remote() → get_remote() - Update all tests to use new API names
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
why: Users need detailed migration guidance when upgrading. what: - Document _all parameter renamings with before/after examples - Document remotes()/remote() getter method renames - Include tables showing old vs new parameter/method names
tony
force-pushed
the
api-renaming-getters
branch
from
585ecab to
1f490e2
Compare
why: Document best practices for maintaining CHANGES and MIGRATION files. what: - Add section on file structure and purpose - Document where to put PR references (in files, not commit messages) - Explain rationale: avoid linkback notification noise in PRs - Include examples for section headers and bullet items
tony
force-pushed
the
api-renaming-getters
branch
from
1f490e2 to
da3b88b
Compare
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.
Summary
_allparameters to descriptive names following Python community conventions (Django, pytest, Sphinx patterns)get_prefix to getter methods in sync/git.py for consistencyChanges
cmd/git.py - Renamed
_allparameters:clone()_allall_branchesfetch()_allall_remotespull()_allall_remoteshelp()_allshow_allrev_list()_allinclude_all_refsremote.get_url()_allall_urlsstash.save()_allinclude_ignoredstash.push()_allinclude_ignoredbranches.ls()_allall_branchessync/git.py - Renamed getter methods:
remotes()get_remotes()remote(name)get_remote(name)Test plan