docs: addition of param and result sections #98
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| """Check that deposit has a defined status (default: draft). | ||
|
|
||
| :param method: Function executed if record has a defined status. | ||
| :params status: Defined status to check. |
There was a problem hiding this comment.
I'd use param instead of params.
http://www.sphinx-doc.org/en/stable/domains.html#info-field-lists
There was a problem hiding this comment.
ups.. you are right... I'll change all XD
hachreak
force-pushed
the
95_docs
branch
3 times, most recently
from
247d30e
to
1c48fe2
Compare
hachreak
force-pushed
the
95_docs
branch
3 times, most recently
from
cf0c16d
to
2a06ff2
Compare
Traceback (most recent call last):
File "/usr/local/lib/python2.7/site-packages/sphinx/cmdline.py", line 244, in main
app.build(opts.force_all, filenames)
File "/usr/local/lib/python2.7/site-packages/sphinx/application.py", line 297, in build
self.builder.build_update()
File "/usr/local/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 251, in build_update
'out of date' % len(to_build))
File "/usr/local/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 322, in build
self.write(docnames, list(updated_docnames), method)
File "/usr/local/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 360, in write
self._write_serial(sorted(docnames), warnings)
File "/usr/local/lib/python2.7/site-packages/sphinx/builders/__init__.py", line 370, in _write_serial
self.warn(*warning, **kwargs)
File "/usr/local/lib/python2.7/site-packages/sphinx/application.py", line 360, in warn
raise SphinxWarning(warntext)
SphinxWarning: :1: WARNING: py:class reference target not found: Record@jirikuncar |
|
@hachreak you need to configure intersphinx in |
| intersphinx_mapping = { | ||
| 'https://docs.python.org/': None, | ||
| 'invenio-pidstore': ('http://pythonhosted.org/invenio-pidstore', None), | ||
| 'invenio-records': ('http://pythonhosted.org/invenio-records', None), |
There was a problem hiding this comment.
You probably also need invenio-records-files.
|
@hachreak what about |
I configured also |
hachreak
changed the title
hachreak
changed the title
| """Update index.""" | ||
| """Decorator to update index. | ||
|
|
||
| :param method: Function wrapped. (Default: None). |
There was a problem hiding this comment.
. (Default: ``None``)
. (Default: ``'draft'``)
- After dot then I would not add another one after brackets.
- Inside param description (before last dot).
| Initialize the CLI and all UI endpoints. | ||
| Connect all signals if `DEPOSIT_REGISTER_SIGNALS` is True. | ||
|
|
||
| :param app: The Flask application. |
There was a problem hiding this comment.
What about?
An instance of :class:`~flask.app.Flask`.
jirikuncar
added
Type: enhancement
Status: in work
Need: documentation
and removed
Status: in review
labels
hachreak
force-pushed
the
95_docs
branch
3 times, most recently
from
67ee421
to
ca1dca9
Compare
|
blocked by: inveniosoftware/invenio-records-rest#105 |
hachreak
force-pushed
the
95_docs
branch
4 times, most recently
from
67f9aad
to
2d5ee11
Compare
| :param method: Function to execute. (Default: ``None``) | ||
| :param result: If `True` returns the result of method execution, | ||
| otherwise `self`. (Default: ``True``) | ||
| :param fields: List of fields to preserve (default: ('_deposit',)). |
There was a problem hiding this comment.
(Default: ``('_deposit', )``).
bc7ab90
to
bea0757
Compare
* Improves documentation. (addresses inveniosoftware#95) Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
|
ping @jirikuncar |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Leonardo Rossi leonardo.r@cern.ch