Skip to content

Commit

Permalink
Further refine some docstring revisions
Browse files Browse the repository at this point in the history
  • Loading branch information
EliahKagan committed Feb 29, 2024
1 parent ffeb7e7 commit ec93955
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
16 changes: 9 additions & 7 deletions git/cmd.py
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,10 @@ def handle_process_output(
Assume stdout/stderr streams are binary and decode them before pushing their
contents to handlers.
This defaults to ``True``. Set it to ``False``:
This defaults to ``True``. Set it to ``False`` if:
- if ``universal_newlines == True``, as then streams are in text mode, or
- if decoding must happen later, such as for :class:`~git.diff.Diff`\s.
- ``universal_newlines == True``, as then streams are in text mode, or
- decoding must happen later, such as for :class:`~git.diff.Diff`\s.
:param kill_after_timeout:
:class:`float` or ``None``, Default = ``None``
Expand Down Expand Up @@ -1085,13 +1085,15 @@ def execute(
specify may not be the same ones.
:return:
* str(output) if extended_output = False (Default)
* tuple(int(status), str(stdout), str(stderr)) if extended_output = True
* str(output), if `extended_output` is ``False`` (Default)
* tuple(int(status), str(stdout), str(stderr)),
if `extended_output` is ``True``
If `output_stream` is ``True``, the stdout value will be your output stream:
* output_stream if extended_output = False
* tuple(int(status), output_stream, str(stderr)) if extended_output = True
* output_stream, if `extended_output` is ``False``
* tuple(int(status), output_stream, str(stderr)),
if `extended_output` is ``True``
Note that git is executed with ``LC_MESSAGES="C"`` to ensure consistent
output regardless of system language.
Expand Down
4 changes: 2 additions & 2 deletions git/diff.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ def diff(
create_patch: bool = False,
**kwargs: Any,
) -> "DiffIndex":
"""Create diffs between two items being trees, trees and index or an
index and the working tree. Detects renames automatically.
"""Create diffs between two items being trees, trees and index or an index and
the working tree. Detects renames automatically.
:param other:
This the item to compare us with.
Expand Down

0 comments on commit ec93955

Please sign in to comment.