To be used with programming questions that uses epytext markup language.
Questions tagged [epytext]
2 questions
7
votes
1 answer
How to document kwargs using epytext for the auto completion hinting in PyCharm?
Is is possible to get an additional hint for kwargs, which will give you examples of predefined possible keyword arguments? Maybe epytext is not supporting it?
class Person():
def __init__(self, **kwargs):
"""
@param name: Name
…
MagSec
- 346
- 4
- 17
1
vote
1 answer
Python: how to document the return value when returning multiple values, using epytext?
A simple function:
def foo():
a = 1
b = 2
return a, b
How would you document the (multiple) return value using epytext-style?
As a single tuple?
def foo():
"""
This function
@return (a, b): a tuple of a and b…
Giora Simchoni
- 3,487
- 3
- 34
- 72