Full python docstring not included in web API docs
Offen
@LiamConnors arbeitet bereits daran.
Seit 11.7.2024.
bug
documentation
P3
- Vorherrschende Sprache
- Python
- Sterne
- 18.8k
- Forks
- 2.8k
- Ø Merge
- 16 Std. 26 Min.
- Gemergte PRs (30 T.)
- 21
Beschreibung
It looks like only the first section in the python docstring is included in the API docs?
If you look at the documentation for e.g. Cone:
anchor – Sets the cones’ anchor with respect to their x/y/z positions. Note that “cm” denote the cone’s center of mass which corresponds to 1/4 from the tail to tip.
(This is nonsense: What is "cm"? What is the datatype and allowed input for anchor?)
But cone.py contains a docstring with more content:
def anchor(self):
"""
Sets the cones' anchor with respect to their x/y/z positions.
Note that "cm" denote the cone's center of mass which
corresponds to 1/4 from the tail to tip.
The 'anchor' property is an enumeration that may be specified as:
- One of the following enumeration values:
['tip', 'tail', 'cm', 'center']
Returns
-------
Any
"""
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Bewertung
Dieses Issue wurde noch nicht bewertet.