diff options
| author | Zack M. Davis <zdavis@swiftstack.com> | 2015-09-10 14:37:32 -0700 |
|---|---|---|
| committer | Zack M. Davis <zdavis@swiftstack.com> | 2015-09-10 15:19:26 -0700 |
| commit | 6b3638ecec3049023420dce16f06549585e2fb8b (patch) | |
| tree | 26eb4baa2be0c9bb4806884d32a6f6c7d4e9fb44 /doc/source | |
| parent | a2c84e0c937c49557f905b018eddac9ba82ea2dd (diff) | |
| download | python-swiftclient-6b3638ecec3049023420dce16f06549585e2fb8b.tar.gz | |
enable autodocumentation for utils module; docstring fixes
This commit adds the utils module to those for which Sphinx
automatically generates documentation from docstrings. (Many of the
functions here may be of little interest to users, but
`generate_temp_url`, at least, definitely deserves to be in the
documentation; in this way, this commit can be seen as a spiritual
companion to ca70dd9e.)
Also, a few markup errors and perceived infelicities in existing
docstrings are amended.
Change-Id: I8c66a23cb359d7dd9302a16459fad9825fedb690
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/swiftclient.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/source/swiftclient.rst b/doc/source/swiftclient.rst index 0a07471..e96afba 100644 --- a/doc/source/swiftclient.rst +++ b/doc/source/swiftclient.rst @@ -24,3 +24,8 @@ swiftclient.multithreading ========================== .. automodule:: swiftclient.multithreading + +swiftclient.utils +================= + +.. automodule:: swiftclient.utils |