Skip to content

Commit

Permalink
tiny format fix in api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
aschleg committed Nov 10, 2019
1 parent 1bed4ef commit c826cd3
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 8 deletions.
Binary file modified docs/build/doctrees/api.doctree
Binary file not shown.
Binary file modified docs/build/doctrees/environment.pickle
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/build/html/_sources/api.rst.txt
Expand Up @@ -14,8 +14,8 @@ API Reference

The Petfinder class provides the wrapper for the Petfinder API. The API methods are listed below

:param: key: API key received from Petfinder after creating a developer account.
:param: secret: Secret key received from Petfinder.
:param key: API key received from Petfinder after creating a developer account.
:param secret: Secret key received from Petfinder.

.. code-block:: python
Expand Down
8 changes: 5 additions & 3 deletions docs/build/html/api.html
Expand Up @@ -171,9 +171,11 @@ <h2><code class="xref py py-mod docutils literal notranslate"><span class="pre">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Param:</th><td class="field-body">key: API key received from Petfinder after creating a developer account.</td>
</tr>
<tr class="field-even field"><th class="field-name">Param:</th><td class="field-body">secret: Secret key received from Petfinder.</td>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>key</strong> – API key received from Petfinder after creating a developer account.</li>
<li><strong>secret</strong> – Secret key received from Petfinder.</li>
</ul>
</td>
</tr>
</tbody>
</table>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/source/api.rst
Expand Up @@ -14,8 +14,8 @@ API Reference

The Petfinder class provides the wrapper for the Petfinder API. The API methods are listed below

:param: key: API key received from Petfinder after creating a developer account.
:param: secret: Secret key received from Petfinder.
:param key: API key received from Petfinder after creating a developer account.
:param secret: Secret key received from Petfinder.

.. code-block:: python
Expand Down

0 comments on commit c826cd3

Please sign in to comment.