You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
AGENTS(docs[Naming Conventions]): Add API naming conventions
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
# GOOD - consistent getter naming for subprocess calls
222
+
defget_remotes(): ...
223
+
defget_revision(): ...
224
+
```
225
+
226
+
**Rationale:** Major Python projects (Django, pytest, Sphinx) don't use `_all` style prefixes. They either use the built-in name directly as a keyword-only argument, or use descriptive alternatives. Underscore prefixes are reserved for private/internal parameters only.
227
+
193
228
### Docstrings
194
229
195
230
Follow NumPy docstring style for all functions and methods:
0 commit comments