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
autodoc renders every field of a NamedTuple, dataclass, or TypedDict whether or not the docstring describes it. An undocumented NamedTuple field reaches the API docs as "Alias for field number 0"; a dataclass or TypedDict field reaches it bare. AGENTS.md now requires an Attributes section covering every field, and this issue tracks the code that predates that rule.
14 classes are missing an Attributes entry for 74 fields in total.
Rendered on the published site today
These modules are named by an autodoc directive under docs/, so the stubs are live in the API docs right now.
SubprocessCommand (dataclass) in libvcs._internal.subprocess — missing args, bufsize, executable, stdin, stdout, stderr, preexec_fn, close_fds, shell, cwd, env, creationflags, +13 more
SyncError (dataclass) in libvcs.sync.base — missing step, message, exception
SyncResult (dataclass) in libvcs.sync.base — missing ok, errors
VCSLocation (NamedTuple) in libvcs.sync.base — missing url, rev
GitRemote (dataclass) in libvcs.sync.git — missing name, fetch_url, push_url
SvnPipURL (dataclass) in libvcs.url.svn — missing rev
Fixing one
Add a NumPy-style Attributes section naming every field, with its type and what it holds:
classExample(t.NamedTuple):
"""One-line summary. Attributes ---------- path : pathlib.Path | None What this field holds, and what ``None`` means. """
Partial coverage does not help: a class with three fields and two documented still ships a stub for the third.
Links are permalinks anchored to v0.45.1; a file that changed since the last release is linked at the current trunk commit instead. Produced by a static AST scan of the package for NamedTuple, dataclass, and TypedDict classes whose docstring omits a field, excluding tests and private classes.
autodoc renders every field of a
NamedTuple, dataclass, orTypedDictwhether or not the docstring describes it. An undocumentedNamedTuplefield reaches the API docs as "Alias for field number 0"; a dataclass orTypedDictfield reaches it bare.AGENTS.mdnow requires anAttributessection covering every field, and this issue tracks the code that predates that rule.14 classes are missing an
Attributesentry for 74 fields in total.Rendered on the published site today
These modules are named by an autodoc directive under
docs/, so the stubs are live in the API docs right now.SubprocessCommand(dataclass) inlibvcs._internal.subprocess— missingargs,bufsize,executable,stdin,stdout,stderr,preexec_fn,close_fds,shell,cwd,env,creationflags, +13 moreSyncError(dataclass) inlibvcs.sync.base— missingstep,message,exceptionSyncResult(dataclass) inlibvcs.sync.base— missingok,errorsVCSLocation(NamedTuple) inlibvcs.sync.base— missingurl,revGitRemote(dataclass) inlibvcs.sync.git— missingname,fetch_url,push_urlGitStatus(dataclass) inlibvcs.sync.git— missingbranch_oid,branch_head,branch_upstream,branch_ab,branch_ahead,branch_behindRule(dataclass) inlibvcs.url.base— missingweightGitBaseURL(dataclass) inlibvcs.url.git— missingurl,scheme,user,hostname,port,path,suffix,ruleGitAWSCodeCommitURL(dataclass) inlibvcs.url.git— missingregion,revGitPipURL(dataclass) inlibvcs.url.git— missingrevHgBaseURL(dataclass) inlibvcs.url.hg— missingurl,scheme,user,hostname,port,separator,path,suffix,ref,ruleHgPipURL(dataclass) inlibvcs.url.hg— missingrevSvnBaseURL(dataclass) inlibvcs.url.svn— missingurl,scheme,user,hostname,port,separator,path,ref,ruleSvnPipURL(dataclass) inlibvcs.url.svn— missingrevFixing one
Add a NumPy-style
Attributessection naming every field, with its type and what it holds:Partial coverage does not help: a class with three fields and two documented still ships a stub for the third.
Links are permalinks anchored to
v0.45.1; a file that changed since the last release is linked at the current trunk commit instead. Produced by a static AST scan of the package forNamedTuple, dataclass, andTypedDictclasses whose docstring omits a field, excluding tests and private classes.