Skip to content

Commit ec93955

Browse files
committed
Further refine some docstring revisions
1 parent ffeb7e7 commit ec93955

File tree

2 files changed

+11
-9
lines changed

2 files changed

+11
-9
lines changed

Diff for: git/cmd.py

+9-7
Original file line numberDiff line numberDiff line change
@@ -127,10 +127,10 @@ def handle_process_output(
127127
Assume stdout/stderr streams are binary and decode them before pushing their
128128
contents to handlers.
129129
130-
This defaults to ``True``. Set it to ``False``:
130+
This defaults to ``True``. Set it to ``False`` if:
131131
132-
- if ``universal_newlines == True``, as then streams are in text mode, or
133-
- if decoding must happen later, such as for :class:`~git.diff.Diff`\s.
132+
- ``universal_newlines == True``, as then streams are in text mode, or
133+
- decoding must happen later, such as for :class:`~git.diff.Diff`\s.
134134
135135
:param kill_after_timeout:
136136
:class:`float` or ``None``, Default = ``None``
@@ -1085,13 +1085,15 @@ def execute(
10851085
specify may not be the same ones.
10861086
10871087
:return:
1088-
* str(output) if extended_output = False (Default)
1089-
* tuple(int(status), str(stdout), str(stderr)) if extended_output = True
1088+
* str(output), if `extended_output` is ``False`` (Default)
1089+
* tuple(int(status), str(stdout), str(stderr)),
1090+
if `extended_output` is ``True``
10901091
10911092
If `output_stream` is ``True``, the stdout value will be your output stream:
10921093
1093-
* output_stream if extended_output = False
1094-
* tuple(int(status), output_stream, str(stderr)) if extended_output = True
1094+
* output_stream, if `extended_output` is ``False``
1095+
* tuple(int(status), output_stream, str(stderr)),
1096+
if `extended_output` is ``True``
10951097
10961098
Note that git is executed with ``LC_MESSAGES="C"`` to ensure consistent
10971099
output regardless of system language.

Diff for: git/diff.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ def diff(
112112
create_patch: bool = False,
113113
**kwargs: Any,
114114
) -> "DiffIndex":
115-
"""Create diffs between two items being trees, trees and index or an
116-
index and the working tree. Detects renames automatically.
115+
"""Create diffs between two items being trees, trees and index or an index and
116+
the working tree. Detects renames automatically.
117117
118118
:param other:
119119
This the item to compare us with.

0 commit comments

Comments
 (0)