autoDocstring Update docstring

Update docstring

Open Bloodmallet opened this issue 6 years ago • 19 comments

Hey, I was wondering whether there was already a way to auto-update docstrings.

def start(a):
  """[summary]
  
  Arguments:
    a {[type]} -- [description]
  """
  pass

to auto update to:

def changed(a,b):
  """[summary]
  
  Arguments:
    a {[type]} -- [description]
    b {[type]} -- [description]
  """
  pass

keeping the values of the already existing data lines.

And if some argument disappears, keep track of it in "Deleted" for example:

def deleted(b):
  """[summary]
  
  Arguments:
    b {[type]} -- [description]

  Deleted:
    a {[type]} -- [description]
  """
  pass

Feb 21 '18 14:02 Bloodmallet

Hi Bloodmallet, Thanks for the suggestion. I will take a look at what would be required to implement this feature. At first glance, I think this may be a little difficult as I'd have to build a whole separate parser for docstrings. But it also looks like a fun challenge so I'll give it a go when I have some time.

Feb 28 '18 07:02 NilsJPWerner

Thank you for considering it!

Feb 28 '18 08:02 Bloodmallet

+1 for this feature. I implemented this for SublimeAutoDocstring and can say update functionality is a little tricky to do correctly, but it's a super handy feature. I would love to help if you have any questions. Unfortunately, my javascript is rusty and I haven't touched TypeScript, so you probably don't want me touching your code.

Mar 04 '18 19:03 KristoforMaynard

@KristoforMaynard Oh awesome! I'll take a look at your code and maybe ask you if I have any questions.

Mar 05 '18 04:03 NilsJPWerner

Any update on this front? Any idea on when this feature will be available?

Nov 10 '18 07:11 kanihal

Aaah, how I miss this from SublimeText. @KristoforMaynard, your work was really appreciated! I came here hoping I might be able to contribute, but my JS experience is about zero, and I barely know TS is a thing. :(

So, just saying that this feature would push this extension way over the top, into indispensable tier, if that helps motivate at all!

Jul 18 '19 01:07 JonathanShor

Hi thanks for the praise. I haven't begun building this feature yet, but the new templating backend could make this an easier thing to implement.

Jul 18 '19 01:07 NilsJPWerner

Any update on this feature? Currently, I'm using sublime-text only to update and instantiate my doc strings. Would make your awesome extension 10 times more valuable to the community! Keep up the good work.

Jan 20 '20 00:01 schlowm0

This is going to a super useful feature. Was searching on how to do it with this extension till I reached here. Can be tricky but shouldn't be too hard. Looking forward to it.