docs: addition of param and result sections #33
Conversation
hachreak
force-pushed
the
31_docs
branch
5 times, most recently
from
a17fe11
to
54a9611
Compare
| @@ -49,7 +49,7 @@ | |||
|
|
|||
| extras_require = { | |||
| 'docs': [ | |||
| 'Sphinx>=1.4.2', | |||
| 'Sphinx==1.4.4', | |||
There was a problem hiding this comment.
Please keep it >=1.4.4 and remove :undoc-members: that cause problems with autodoc module (anyway we should not have any undocumented functions/attributes).
hachreak
force-pushed
the
31_docs
branch
2 times, most recently
from
3d1e4a4
to
99ebeaf
Compare
hachreak
changed the title
|
|
||
| Example of bulk indexing: | ||
|
|
||
| .. code-block:: python |
There was a problem hiding this comment.
@hachreak if we present python examples in the docstrings they should be runnable via doctests.
There was a problem hiding this comment.
the tests are passing, it means that it's fine? Or I need to do something more?
There was a problem hiding this comment.
Well the point is that the docstring is not tested so if something changes we will have outdated example.
| :param exchange: ``kombu.Exchange`` instance for message queue. | ||
| :param queue: ``kombu.Queue`` instance for message queue. | ||
| :param routing_key: Routing key for message queue. | ||
| :param version_type: Elasticsearch version type. Defaults to |
There was a problem hiding this comment.
(Default: ``external_gte``)
cc7ce56
to
bcef1a6
Compare
| If it fails, return the default values. | ||
|
|
||
| :param record: The record object. | ||
| :returns: Tuple (index, doc_type) |
| @@ -223,6 +258,8 @@ def _bulk_op(self, record_id_iterator, op_type, index=None, doc_type=None): | |||
| :param record_id_iterator: Iterator that yields record UUIDs. | |||
| :param op_type: Indexing operation (one of ``index``, ``create``, | |||
| ``delete`` or ``update``). | |||
| :param index: The Elasticsearch index (Default: ``None``). | |||
There was a problem hiding this comment.
can you move the dot before (Default ...)?
hachreak
force-pushed
the
31_docs
branch
2 times, most recently
from
f17c083
to
82ecec3
Compare
|
ping @jirikuncar |
|
|
||
| r"""Minimal Flask application example for development. | ||
|
|
||
|
|
|
@hachreak we can merge the docs improvements. Can you move the example app to separate PR so we have time to check it well? Thanks |
* Improves documentation. (addresses inveniosoftware#31) Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
|
ping @jirikuncar |
Signed-off-by: Leonardo Rossi leonardo.r@cern.ch