From 3d643787d294fa92699691226c5c2700b94b02a1 Mon Sep 17 00:00:00 2001 From: diminator Date: Tue, 10 Jan 2017 11:41:04 +0100 Subject: [PATCH] update docstring --- bigchaindb/web/views/votes.py | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/bigchaindb/web/views/votes.py b/bigchaindb/web/views/votes.py index 0e5df94f..9fb306a1 100644 --- a/bigchaindb/web/views/votes.py +++ b/bigchaindb/web/views/votes.py @@ -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: - 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): 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: - A ``dict`` in the format ``{'status': }``, where - ```` is one of "valid", "invalid", "undecided", "backlog". + A list of votes voting for a block with ID ``block_id``. """ parser = reqparse.RequestParser() parser.add_argument('block_id', type=str)