diff options
| author | Sachin Patil <psachin@redhat.com> | 2018-03-16 15:26:32 +0530 |
|---|---|---|
| committer | Bryn M. Reeves <bmr@redhat.com> | 2018-06-06 14:59:22 +0100 |
| commit | 81d31ecf6aacda7268ebd4f795376dd22f18e6c0 (patch) | |
| tree | 065afc87604dc4e81846bee7093998a50e1b3514 /LICENSE | |
| parent | ced2719d4fcb7dc111c048f20b589b9de0b2d370 (diff) | |
| download | sos-81d31ecf6aacda7268ebd4f795376dd22f18e6c0.tar.gz | |
[docs] Fixed errors while generating docs.
I see below errors when generating docs using `make`. Decided to
cleanup a bit. The docstring look better than previous and no more
errors when generating docs.
```
/home/psachin/github/sos/sos/plugins/__init__.py:docstring of sos.plugins.Plugin.add_journal:5: ERROR: Unexpected indentation.
/home/psachin/github/sos/sos/plugins/__init__.py:docstring of sos.plugins.Plugin.add_journal:6: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/psachin/github/sos/sos/plugins/__init__.py:docstring of sos.plugins.Plugin.add_journal:13: WARNING: Definition list ends without a blank line; unexpected unindent.
/home/psachin/github/sos/sos/plugins/__init__.py:docstring of sos.plugins.Plugin.add_journal:15: ERROR: Unexpected indentation.
/home/psachin/github/sos/sos/plugins/__init__.py:docstring of sos.plugins.Plugin.add_journal:16: WARNING: Block quote ends without a blank line; unexpected unindent.
/home/psachin/github/sos/sos/plugins/__init__.py:docstring of sos.plugins.Plugin.add_journal:18: WARNING: Definition list ends without a blank line; unexpected unindent.
```
I tried to keep the changes in Sphinx format. Not all functions are
changed in this patch but the one generating errors.
Let me know if anything else needs cleanup in `sos/sos/plugins/__init__.py`
Signed-off-by: Sachin Patil <psachin@redhat.com>
Signed-off-by: Bryn M. Reeves <bmr@redhat.com>
Diffstat (limited to 'LICENSE')
0 files changed, 0 insertions, 0 deletions