Skip to content
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.

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

Module docstring says TagReference but means TagObject #1873

Closed
EliahKagan opened this issue Mar 14, 2024 · 0 comments · Fixed by #1859
Closed

Module docstring says TagReference but means TagObject #1873

EliahKagan opened this issue Mar 14, 2024 · 0 comments · Fixed by #1859

Comments

@EliahKagan
Copy link
Contributor

EliahKagan commented Mar 14, 2024

The git.objects.tag module holds the TagObject class that represents tag objects, representing annotated tags, which are git objects, while of course the TagReference class represents lightweight tags, which are git references.

When updating docstrings in 6126997 (#1850), I tried to say this, and even was aware that it was easy to write the wrong identifier while editing multiple docstrings, and I checked for this mistake, yet still it was not enough and I made the docstring say the exact opposite:

This defines the :class:`TagReference` class, which represents annotated tags.
For lightweight tags, see the :mod:`git.refs.tag` module.

A fix for this is included in #1859, at 1cdec7a, and I anticipate that #1859, expanded to properly fix #1858 and integrate changes from other PRs, will be ready for review very soon. Nonetheless I'm opening this issue so that, if it turns out there are delays and a release has to be made, that commit can be cherry-picked or its fix otherwise applied.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants