docs: addition of method documentation #25
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
| """Get file from a record.""" | ||
| """Get file from a record. | ||
|
|
||
| :param pid: TODO: Not used. |
There was a problem hiding this comment.
This parameter (pid) is not used.
There was a problem hiding this comment.
We can call it dummy or _ and in docstring say that it's just to keep function signature.
| @@ -135,7 +135,7 @@ | |||
| >>> print(record.files['hello.txt']['filetype']) | |||
| txt | |||
|
|
|||
| Certain key names are however reserved cannot be used for **setting** metadata: | |||
| Certain key names are horaisewever reserved cannot be used for **setting** metadata: | |||
JavierDelgadoFernandez
force-pushed
the
23-api-docs
branch
2 times, most recently
from
6e99d44
to
80d3b4e
Compare
| """Return file keys.""" | ||
| """Return file keys. | ||
|
|
||
| :returns: Key list of the files files. |
There was a problem hiding this comment.
@JavierDelgadoFernandez can you rephrase this line? List of file keys.?
JavierDelgadoFernandez
force-pushed
the
23-api-docs
branch
from
80d3b4e
to
3a1a4a2
Compare
|
|
||
| :raises InvalidOperationError: It occurs when the bucket is locked or | ||
| deleted. | ||
| """ |
There was a problem hiding this comment.
I know that this documentation is not showed (Actually not even the _writable method), but if someone is reviewing the code, it will be helpful.
JavierDelgadoFernandez
force-pushed
the
23-api-docs
branch
2 times, most recently
from
3093674
to
0d96fba
Compare
|
@jirikuncar Updated. |
JavierDelgadoFernandez
force-pushed
the
23-api-docs
branch
from
0d96fba
to
0adecd8
Compare
| intersphinx_mapping = { | ||
| 'https://docs.python.org/': None, | ||
| 'invenio-files-rest': ( | ||
| 'http://pythonhosted.org/invenio-files-rest', None |
JavierDelgadoFernandez
force-pushed
the
23-api-docs
branch
from
0adecd8
to
4191d5c
Compare
|
@jirikuncar Updated. |
|
|
||
| :param record: Record used to relate with the ``Bucket``. | ||
| :param bucket: Bucket used to relate with the ``Record``. | ||
| :returns: The :class:`invenio_records_files.models.RecordsBuckets` |
There was a problem hiding this comment.
You can use ~ to show only class name in generated docs.
JavierDelgadoFernandez
force-pushed
the
23-api-docs
branch
from
4191d5c
to
6228301
Compare
* Improves method documentation. (addresses inveniosoftware#23) Signed-off-by: Javier Delgado <javier.delgado.fernandez@cern.ch>
JavierDelgadoFernandez
force-pushed
the
23-api-docs
branch
from
6228301
to
3540d99
Compare
|
@jirikuncar Updated. |
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: Javier Delgado javier.delgado.fernandez@cern.ch