Skip to content

Update existing docstring #34

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
pixelneo opened this issue Jan 19, 2023 · 2 comments
Open

Update existing docstring #34

pixelneo opened this issue Jan 19, 2023 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@pixelneo
Copy link
Owner

Why: Now, a new docstring is always created. On a change of some arguments, on function that already has some docstring, that docstring should only be updated – new args added, old ones removed.

@pixelneo pixelneo added the enhancement New feature or request label Jan 19, 2023
@pixelneo pixelneo self-assigned this Jan 19, 2023
@pixelneo
Copy link
Owner Author

methods and functions only (in this issue)

@pixelneo
Copy link
Owner Author

expected behaviour

1. before

def foo(a: str):
    """ Some description
    
    Args: 
        a (str): bar
    
    Returns:
         something
    """
    return 0

2. making changes in function

Changes in function only. Docstring not manually changed.

def foo(a: str, b:int):
    """ Some description
    
    Args: 
        a (str): bar
    
    Returns:
         something
    """
    yield 0

3. regenate docstring

def foo(a: str, b:int):
    """ Some description
    
    Args: 
        a (str): bar
        b (int): 
    
    Yields:

    """
    yield 0

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

No branches or pull requests

1 participant