WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit b6f39d6

Browse files
committed
docs(url): Drop duplicate autodoc targets
why: Sphinx reported duplicate object descriptions for SubprocessCommand fields and URL rule attributes. what: - remove redundant attribute lists that created duplicate targets in subprocess and URL base docs
1 parent 47188b8 commit b6f39d6

File tree

4 files changed

+0
-88
lines changed

4 files changed

+0
-88
lines changed

src/libvcs/_internal/subprocess.py

Lines changed: 0 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -77,79 +77,6 @@ def __init__(self, output: str, *args: object) -> None:
7777
class SubprocessCommand(SkipDefaultFieldsReprMixin):
7878
"""Wraps a :mod:`subprocess` request. Inspect, mutate, control before invocation.
7979
80-
Attributes
81-
----------
82-
args : _CMD
83-
A string, or a sequence of program arguments.
84-
85-
bufsize : int
86-
supplied as the buffering argument to the open() function when creating the
87-
stdin/stdout/stderr pipe file objects
88-
89-
executable : Optional[StrOrBytesPath]
90-
A replacement program to execute.
91-
92-
stdin : _FILE
93-
standard output for executed program
94-
95-
stdout :
96-
standard output for executed program
97-
98-
stderr :
99-
standard output for executed program
100-
101-
close_fds : Controls closing or inheriting of file descriptors.
102-
103-
shell : If true, the command will be executed through the shell.
104-
105-
cwd : Sets the current directory before the child is executed.
106-
107-
env : Defines the environment variables for the new process.
108-
109-
text :
110-
If ``True``, decode stdin, stdout and stderr using the given encoding (if set)
111-
or the system default otherwise.
112-
113-
universal_newlines :
114-
Alias of text, provided for backwards compatibility.
115-
116-
startupinfo :
117-
Windows only
118-
119-
creationflags :
120-
Windows only
121-
122-
preexec_fn :
123-
(POSIX only) An object to be called in the child process just before the child
124-
is executed.
125-
126-
restore_signals :
127-
POSIX only
128-
129-
start_new_session :
130-
POSIX only
131-
132-
group :
133-
POSIX only
134-
135-
extra_groups :
136-
POSIX only
137-
138-
user :
139-
POSIX only
140-
141-
umask :
142-
POSIX only
143-
144-
pass_fds :
145-
POSIX only
146-
147-
encoding :
148-
Text mode encoding to use for file objects stdin, stdout and stderr.
149-
150-
errors :
151-
Text mode error handling to use for file objects stdin, stdout and stderr.
152-
15380
Examples
15481
--------
15582
>>> cmd = SubprocessCommand("ls")

src/libvcs/url/git.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -322,11 +322,6 @@ class GitBaseURL(
322322
323323
- Compatibility checking: :meth:`GitBaseURL.is_valid()`
324324
- URLs compatible with ``git(1)``: :meth:`GitBaseURL.to_url()`
325-
326-
Attributes
327-
----------
328-
rule : str
329-
name of the :class:`~libvcs.url.base.Rule`
330325
"""
331326

332327
url: str

src/libvcs/url/hg.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -155,11 +155,6 @@ class HgBaseURL(
155155
):
156156
"""Mercurial repository location. Parses URLs on initialization.
157157
158-
Attributes
159-
----------
160-
rule : str
161-
name of the :class:`~libvcs.url.base.Rule`
162-
163158
Examples
164159
--------
165160
>>> HgBaseURL(url='https://hg.mozilla.org/mozilla-central/')

src/libvcs/url/svn.py

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -174,11 +174,6 @@ class SvnBaseURL(
174174
175175
- Compatibility checking: :meth:`SvnBaseURL.is_valid()`
176176
- URLs compatible with ``svn(1)``: :meth:`SvnBaseURL.to_url()`
177-
178-
Attributes
179-
----------
180-
rule : str
181-
name of the :class:`~libvcs.url.base.Rule`
182177
"""
183178

184179
url: str

0 commit comments

Comments
 (0)