Skip to content

Improve Sphinx role usage, including linking Git manpages #1879

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Mar 16, 2024
Merged

Improve Sphinx role usage, including linking Git manpages #1879

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
0969db9
Put Sphinx conf.py in the same style as other code
EliahKagan Mar 15, 2024
c5a29a9
Link Sphinx manpage references to online Git docs
EliahKagan Mar 15, 2024
7f1675d
Remove a spurious extra backtick from a docstring
EliahKagan Mar 15, 2024
e883293
Add a missing Sphinx reference to a class
EliahKagan Mar 15, 2024
d8ab99c
Use Sphinx manpage references where applicable
EliahKagan Mar 15, 2024
d271a84
Use more official link to index-format documentation
EliahKagan Mar 15, 2024
ca95c42
Use current main official link to git-clone URLS doc
EliahKagan Mar 15, 2024
8543457
Use :const: for constants that had the :attr: role
EliahKagan Mar 15, 2024
6626117
Fix parse_date docstring spacing; use RFC role
EliahKagan Mar 16, 2024
a957ae7
Use the :exc: role for exceptions
EliahKagan Mar 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix parse_date docstring spacing; use RFC role 
There are only a three cases where a specific RFC is mentioned.
Only one is in parse_date and the others are elsewhere.
  • Loading branch information
@EliahKagan
EliahKagan committed Mar 16, 2024
commit 6626117259b93d0a3085dd17ed71ef1acd08c7a5
8 changes: 4 additions & 4 deletions git/objects/commit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -404,8 +404,8 @@ def trailers(self) -> Dict[str, str]:
def trailers_list(self) -> List[Tuple[str, str]]:
"""Get the trailers of the message as a list.

Git messages can contain trailer information that are similar to RFC 822 e-mail
headers. See :manpage:`git-interpret-trailers(1)`.
Git messages can contain trailer information that are similar to :rfc:`822`
e-mail headers. See :manpage:`git-interpret-trailers(1)`.

This function calls ``git interpret-trailers --parse`` onto the message to
extract the trailer information, returns the raw trailer data as a list.
Expand Down Expand Up @@ -456,8 +456,8 @@ def trailers_list(self) -> List[Tuple[str, str]]:
def trailers_dict(self) -> Dict[str, List[str]]:
"""Get the trailers of the message as a dictionary.

Git messages can contain trailer information that are similar to RFC 822 e-mail
headers. See :manpage:`git-interpret-trailers(1)`.
Git messages can contain trailer information that are similar to :rfc:`822`
e-mail headers. See :manpage:`git-interpret-trailers(1)`.

This function calls ``git interpret-trailers --parse`` onto the message to
extract the trailer information. The key value pairs are stripped of leading and
Expand Down
5 changes: 2 additions & 3 deletions git/objects/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,9 +223,8 @@ def parse_date(string_date: Union[str, datetime]) -> Tuple[int, int]:

* Aware datetime instance
* Git internal format: timestamp offset
* RFC 2822: ``Thu, 07 Apr 2005 22:13:13 +0200``
* ISO 8601: ``2005-04-07T22:13:13``
The T can be a space as well.
* :rfc:`2822`: ``Thu, 07 Apr 2005 22:13:13 +0200``
* ISO 8601: ``2005-04-07T22:13:13`` - The ``T`` can be a space as well.

:return:
Tuple(int(timestamp_UTC), int(offset)), both in seconds since epoch
Expand Down