Skip to content

Referenced method in documentation doesn't appear to exist #1407

Open
@gmc444-b

Description

@gmc444-b

The docstring for this commit method references tree.commit for documentation on the arguments, but that method doesn't appear to exist.

What would be the correct reference, or should the documentation for the arguments just be in this docstring?

Activity

Byron

Byron commented on Feb 3, 2022

@Byron
Member

I believe to have found the name of the method it should instead refer to, Commit.create_from_tree().

I'd agree that the documentation could just be repeated, by now one could consider all of this stable enough, which is why this issue can remain open to improve on cd29f07 .

gcmarx

gcmarx commented on May 22, 2025

@gcmarx
Contributor

This looks like it's complete - there are no references to tree.commit in the repo in the newest version that I could find.

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @Byron@gmc444-b@gcmarx

        Issue actions

          Referenced method in documentation doesn't appear to exist · Issue #1407 · gitpython-developers/GitPython