Questions about docstring
Read more about docstring
python (65.1k questions)
javascript (44.2k questions)
reactjs (22.7k questions)
java (20.8k questions)
c# (17.4k questions)
html (16.3k questions)
r (13.7k questions)
android (12.9k questions)
How to use a long string as a descriptive docstring for a number of functions
I have created a util python file that contains many functions in it. I want to use a long string to be used as a descriptive docstring for some of them, which can be shown with help(functionname). Is...
maryam sh
Votes: 0
Answers: 1
JSDoc: Auto detecting class methods
My jsdocs look like the following
module.exports = class gateio extends Exchange {
/**
* @class
* @name gateio
*/
async fetchOrder (id, symbol = undefined, params = {}) {
...
Sam
Votes: 0
Answers: 1
Sphinx-autodoc with napoleon (Google Doc String Style): Warnings and Errors about Block quotes and indention
I am using Sphinx 4.4.0 with napoleon extension (Google Doc String). I have this two problems
ARNING: Block quote ends without a blank line; unexpected unindent.
ERROR: Unexpected indentation.
I fou...
buhtz
Votes: 0
Answers: 1
Use module docstrings in Sphinx autodoc
In the Sphinx autodoc generated documentation I want kind of an introduction text for each module. I my logic this is related to the modules docstring. But Sphinx ignores it because it appears nowhere...
buhtz
Votes: 0
Answers: 1