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.

Sign up for GitHub

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

Jump to bottom

Shorten Iterable docstrings and put IterableObj first #1785

Merged
merged 1 commit into from
Dec 23, 2023
Merged

Shorten Iterable docstrings and put IterableObj first #1785

merged 1 commit into from
Dec 23, 2023

Commits on Dec 23, 2023

  1. Shorten Iterable docstrings and put IterableObj first 

    This shortens the git.util.Iterable docstrings, removing most of
the text duplicated from git.util.IterableObj docstrings and
instead referring the reader to the specific corresponding methods
in IterableObj. A comment about return types that appeared in both
places but really only documented IterableObj is likewise removed
from Iterable.

This also reorders the classes, placing IterableObj before Iterable
and its associated metaclass. This makes it easier to find, and may
help remind users that IterableObj is the class they should use.

These changes build on those in dfee31f (gitpython-developers#1780).
    @EliahKagan
    EliahKagan committed Dec 23, 2023
    Configuration menu
    Copy the full SHA
    2b768c7 View commit details
    Browse the repository at this point in the history