Skip to content

Commit

Permalink
Clean up auto-docstrings. (#542)
Browse files Browse the repository at this point in the history
Docstrings for attributes in python don't really exist.  Instead of
fetching them, the autodoc generator now just uses "" as the docstring
for properties that it has to read off the instantiated object.
  • Loading branch information
ssteinbach committed Jul 22, 2019
1 parent 0f9a426 commit cc78a7c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 7 deletions.
9 changes: 3 additions & 6 deletions docs/tutorials/otio-serialized-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,12 +221,9 @@ parameters:
```

parameters:
- *offset*: Represents an instantaneous point in time, value * (1/rate) seconds
from time 0seconds.
- *rate*: None
- *scale*: float(x) -> floating point number

Convert a string or number to a floating point number, if possible.
- *offset*:
- *rate*:
- *scale*:

## Module: opentimelineio.plugins

Expand Down
2 changes: 1 addition & 1 deletion opentimelineio/console/autogen_serialized_datamodel.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@
PROP_FETCHERS = (
lambda cl, k: inspect.getdoc(getattr(cl, k)),
lambda cl, k: inspect.getdoc(getattr(cl, "_" + k)),
lambda cl, k: inspect.getdoc(getattr(cl(), k)),
lambda cl, k: inspect.getdoc(getattr(cl(), k)) and "" or "",
)


Expand Down

0 comments on commit cc78a7c

Please sign in to comment.