question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

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

Issue Analytics

  • State:open
  • Created 6 years ago
  • Reactions:37
  • Comments:19 (4 by maintainers)

github_iconTop GitHub Comments

17reactions
NilsJPWernercommented, Feb 2, 2021

I’m slowly working away at this feature and hope to have a beta out soon.

2reactions
NilsJPWernercommented, Jul 18, 2019

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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

How to update a doc string in python files programatically
Python is quite good for documentation/testing framework. One very cool, is the 'readthedocs' framework. Install sphinx pip install sphinx.
Read more >
How do I update my docstring when my method signature has ...
I am using Pycharm and am using docstrings to document my methods. If I add a new parameter to a method, how do...
Read more >
Python update docstring - ProgramCreek.com
This page shows Python code examples for update docstring.
Read more >
.alter function docstring - Azure Data Explorer | Microsoft Learn
This article describes the .delete table update policy command in Azure Data Explorer. .create-or-alter materialized view - Azure Data Explorer.
Read more >
Update existing docstring in python #28 - kkoomen/vim-doge
As mentionned in #18, it seems possible to implement the update of existing documentation for ... Update existing docstring in python #28.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found