GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Module docstring says TagReference but means TagObject · Issue #1873 · gitpython-developers/GitPython

Module docstring says TagReference but means TagObject #1873

New issue
Copy link
New issue
Copy link
Closed
#1859
Closed
Module docstring says TagReference but means TagObject#1873
#1859
Copy link
Labels
acknowledged

Description

@EliahKagan
EliahKagan
opened on Mar 14, 2024
Issue body actions

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:

GitPython/git/objects/tag.py

Lines 8 to 9 in e880c33

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.

Activity

  1. Byron
    added
    acknowledged
    on Mar 14, 2024
  2. Byron
    closed this as completedin #1859on Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    acknowledged

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402503 — GeezerVison does not store the pages you look up.
      Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.