Get the documentation string for an object. All tabs are expanded to spaces. To clean up docstrings that are indented to line up with blocks of code, any whitespace than can be uniformly removed from the second line onwards is removed.
(object)
| 168 | return None |
| 169 | |
| 170 | def _getdoc(object): |
| 171 | """Get the documentation string for an object. |
| 172 | |
| 173 | All tabs are expanded to spaces. To clean up docstrings that are |
| 174 | indented to line up with blocks of code, any whitespace than can be |
| 175 | uniformly removed from the second line onwards is removed.""" |
| 176 | doc = _getowndoc(object) |
| 177 | if doc is None: |
| 178 | try: |
| 179 | doc = _finddoc(object) |
| 180 | except (AttributeError, TypeError): |
| 181 | return None |
| 182 | if not isinstance(doc, str): |
| 183 | return None |
| 184 | return inspect.cleandoc(doc) |
| 185 | |
| 186 | def getdoc(object): |
| 187 | """Get the doc string or comments for an object.""" |
no test coverage detected