docs: addition of param and result sections #143
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
hachreak
force-pushed
the
140_docs
branch
2 times, most recently
from
52639bd
to
c12380c
Compare
| called with the data as function parameter. | ||
|
|
||
| :param data: Dict with record metadata. | ||
| :param _id: Force the UUID for the record. |
hachreak
changed the title
|
|
||
| :param id_: Record ID. | ||
| :param with_deleted: If `True` then it includes deleted records. | ||
| :returns: The Record instance. | ||
| """ | ||
| with db.session.no_autoflush: | ||
| query = RecordMetadata.query.filter_by(id=id) |
* Improves documentation. (addresses inveniosoftware#140) Signed-off-by: Leonardo Rossi <leonardo.r@cern.ch>
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