Skip to content

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

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

Open
gmc444-b opened this issue Feb 2, 2022 · 1 comment
Open

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

gmc444-b opened this issue Feb 2, 2022 · 1 comment

Comments

@gmc444-b
Copy link

gmc444-b commented Feb 2, 2022

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?

@Byron
Copy link
Member

Byron commented Feb 3, 2022

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 .

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

No branches or pull requests

2 participants