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.

Add valid args, returns & raises docstring for the python files.

See original GitHub issue

The aim of this issue is to implement valid docstring in methods (link below) to implement mandatory check for Args Returns Raises. Currently most of the files having valid docstrings but some files have missing/invalid format Args Returns Raises in their docstring. by solving this we can go ahead and work on #6081

To be assigned to a file or for any queries, comment on the thread and tag @aks681 .

PR’s for reference: #8288

We have created a list of files which need valid docstring:

Completed:

you can check the docstring issues in this doc: https://docs.google.com/document/d/1OiZA4I5ETSDu2K_dYUk2whvdEhV_41exBlPZWdU8cDM/edit?usp=sharing

Issue Analytics

  • State:closed
  • Created 4 years ago
  • Comments:69 (56 by maintainers)

github_iconTop GitHub Comments

1reaction
abhayraghuwanshicommented, Apr 28, 2020

@Showtim3 the Pr od state_domain got merged already Thanks

1reaction
Showtim3commented, Dec 5, 2019

@Arnesh07 Assigned you…

Read more comments on GitHub >

github_iconTop Results From Across the Web

Python Docstrings Tutorial : Examples & Format for Pydoc ...
See Python Docstrings. Learn about the different types of docstrings & various docstring formats like Sphinx, Numpy, and Pydoc with examples now.
Read more >
Example Google Style Python Docstrings - Napoleon
This module demonstrates documentation as specified by the `Google Python ... param2: raise ValueError('param1 may not be equal to param2') return True def ......
Read more >
"Writes" in Google style Python docstring? - Stack Overflow
In Google style Python docstring, one can specify Args , Returns , Raises as follows. I have many functions that, instead of returning...
Read more >
Python Docstring: Documenting And Introspecting Functions
This tutorial explains what is Python Docstring and how to use it to document Python functions with examples.
Read more >
Documenting Python Code: A Complete Guide
Package and Module Docstrings · A brief description of what the function is and what it's used for · Any arguments (both required...
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