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.

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

Update hostname_localhost Docstring #259

Merged
merged 1 commit into from
Jan 31, 2024
Merged

Update hostname_localhost Docstring #259

merged 1 commit into from
Jan 31, 2024

Conversation

jan-janssen
Copy link
Member

No description provided.

@jan-janssen jan-janssen requested a review from liamhuber January 31, 2024 17:24
@jan-janssen jan-janssen merged commit c841760 into main Jan 31, 2024
21 checks passed
@jan-janssen jan-janssen deleted the update_docstrings branch January 31, 2024 17:29
@liamhuber
Copy link
Member

Screen Shot 2024-01-31 at 09 34 08

Six minute's for review seems awfully tight for a review, but I guess it was more of an "@liamhuber fyi"?

Anyhow, content and location seems fine so I approve. Only thing I would add is that there's no way I'd commit myself to maintaining this many copies of what needs to be the same (doc)string. It's your package so do what you want, but I would try to find a way to centralize some of the shared content to guarantee that it stays synchronized and save time during changes, e.g.

HARED_ARGS = """
    foo (int): foo's.
    bar (float): bar's.
"""

class Parent:
    __doc__ = """
    This is the parent class.
    
    Args:
    """ + SHARED_ARGS + """
    
    Now I'm done talking about it.
    """

class Child(Parent):
    __doc__ = """This is the child class.

    """ + SHARED_ARGS + """
        baz (str): It's an arg the parent doesn't have.
        
    A different class suffix.
    """

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

Successfully merging this pull request may close these issues.

2 participants