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

[Feature request] Calling neogen twice should overwrite the exising docstring #69

Closed
theairbend3r opened this issue Feb 11, 2022 · 1 comment

Comments

@theairbend3r
Copy link

The current behaviour is to add the docstring twice:

def my_func(a:int, b:str) -> str:
      """
   
      Parameters
      ----------
      a : int
          
      b : str
          
  
      Returns
      -------
      str
          
      """
      """
   
      Parameters
      ----------
      a : int
          
      b : str
          
  
      Returns
      -------
      str
          
      """
      return a * b

Overwriting the previous docstring would be more intuitive imo.

For example, if I change my function annotation and want to regenerate the docstrings, I'd rather have it overwrite the existing docstring instead of writing a new one below it.

What do you think?

@theairbend3r
Copy link
Author

Discussion in #65.

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

No branches or pull requests

1 participant