update docstrings (e02c09ab) · Commits · nguyen / Best-Worst-Scaling

project/init.py

+3 −2

Original line number	Diff line number	Diff line
		# -- coding: utf-8 --
		"""
		Package ``project``

		This package defines the application.

		@@ -50,7 +51,7 @@ def create_app(config_env):

		def init_extensions(app):
		"""
		Binds each Flask extension to the Flask application instance.
		Bind each Flask extension to the Flask application instance.
		Configure Login manager for multi-login system.

		Args:
		@@ -81,7 +82,7 @@ def init_extensions(app):

		def register_blueprints(app):
		"""
		Registers each Blueprints with the Flask application instance.
		Register each Blueprints with the Flask application instance.

		Args:
		app (:flask:`Flask <flask.Flask>`): application

+2 −1

Original line number	Diff line number	Diff line
		# -- coding: utf-8 --
		"""
		Subpackage ``project.annotator``

		This package defines Annotator-System for annotators to annotate datas.
		This subpackage defines Annotator-System for annotators to annotate datas.

		Main functions:
		* Login

+4 −3

Original line number	Diff line number	Diff line
		# -- coding: utf-8 --
		"""
		Accounts
		##########

		Module ``project.annotator.account``
		*************************************
		Module ``project.annotator.account``

		This modules defines routes to manage accounts of annotators.
		This module defines routes to manage accounts of annotators.

		"""

+5 −4

Original line number	Diff line number	Diff line
		# -- coding: utf-8 --
		"""
		Annotations
		######################

		Module ``project.annotator.annotation``
		****************************************
		Module ``project.annotator.annotation``

		This modules defines routes to manage the annotations.
		This module defines routes to manage the annotations.

		"""

		@@ -124,7 +125,7 @@ def batch(p_name, batch_id):
		def hit(p_name, hit_id):
		"""
		Represent a HIT within the project directed from MTurk for an annotator (turker)
		to annotates at ``/mturk/<p_name>/<hit_id>``.
		to annotate at ``/mturk/<p_name>/<hit_id>``.

		Args:
		p_name (str): name of the project

+5 −2

Original line number	Diff line number	Diff line
		# -- coding: utf-8 --
		"""
		Forms
		******

		Module ``project.annotator.forms``

		Module ``project.annotator.forms``
		###################################

		This module defines forms used inside Annotator-System.

		@@ -32,6 +34,7 @@ class TupleForm(FlaskForm):
		validators= [InputRequired(message=u'Choose one item!'),
		NotEqualTo('best_item', message=u'Two questions for this tuple require 2 different answers')])


		class AnnoCheckinForm(FlaskForm):
		"""
		Extend :fform:`FlaskForm <flask_wtf.FlaskForm>`. Define form for an annotator login-system.