Mirroristas/bigchaindb
2
0
Fork 0
mirror of https://github.com/bigchaindb/bigchaindb.git synced 2024-10-13 13:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docstring

Browse Source
This commit is contained in:
diminator 2017-01-10 11:41:04 +01:00
parent 5608a36616
commit 3d643787d2
No known key found for this signature in database
GPG Key ID: C3D8590E6D0D439A
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
bigchaindb/web/views/votes.py
View File

@ -1,4 +1,4 @@
"""This module provides the blueprint for the statuses API endpoints. """This module provides the blueprint for the votes API endpoints.
For more information please refer to the documentation on ReadTheDocs: For more information please refer to the documentation on ReadTheDocs:
- https://docs.bigchaindb.com/projects/server/en/latest/drivers-clients/ - https://docs.bigchaindb.com/projects/server/en/latest/drivers-clients/
@ -13,11 +13,10 @@ from bigchaindb.web.views.base import make_error
class VotesApi(Resource): class VotesApi(Resource):
def get(self): def get(self):
"""API endpoint to get details about the status of a transaction or a block. """API endpoint to get details about votes on a block.
Return: Return:
A ``dict`` in the format ``{'status': <status>}``, where A list of votes voting for a block with ID ``block_id``.
``<status>`` is one of "valid", "invalid", "undecided", "backlog".
""" """
parser = reqparse.RequestParser() parser = reqparse.RequestParser()
parser.add_argument('block_id', type=str) parser.add_argument('block_id', type=str)