Skip to content

Module docstring says TagReference but means TagObject #1873

Closed
@EliahKagan

Description

@EliahKagan

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy