More docs

quantmind · Feb 13, 2020 · c0bc1c7 · c0bc1c7
1 parent e298403
commit c0bc1c7
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 3 deletions.
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -46,6 +46,26 @@ Email field
 -------------
 .. autofunction:: email_field
 
+Enum field
+----------
+
+.. autofunction:: enum_field
+
+Date field
+----------
+
+.. autofunction:: date_field
+
+Datetime field
+--------------
+
+.. autofunction:: date_time_field
+
+
+JSON field
+----------
+
+.. autofunction:: json_field
 
 Spec
 ====

diff --git a/openapi/data/fields.py b/openapi/data/fields.py
@@ -144,16 +144,26 @@ def email_field(min_length: int = 0, max_length: Optional[int] = None, **kw) ->
 
 
 def enum_field(EnumClass, **kw) -> Field:
+    """A specialized :func:`.data_field` for enums
+
+    :param EnumClass: enum for validation
+    """
     kw.setdefault("validator", EnumValidator(EnumClass))
     return data_field(**kw)
 
 
 def date_field(**kw) -> Field:
+    """A specialized :func:`.data_field` for dates
+    """
     kw.setdefault("validator", DateValidator())
     return data_field(**kw)
 
 
 def date_time_field(timezone=False, **kw) -> Field:
+    """A specialized :func:`.data_field` for datetimes
+
+    :param timezone: timezone for validation
+    """
     kw.setdefault("validator", DateTimeValidator(timezone=timezone))
     return data_field(**kw)
 
@@ -167,6 +177,8 @@ def as_field(item, **kw) -> Field:
 
 
 def json_field(**kw) -> Field:
+    """A specialized :func:`.data_field` for JSON data
+    """
     kw.setdefault("validator", JSONValidator())
     return data_field(**kw)
 

diff --git a/tests/example/endpoints.py b/tests/example/endpoints.py
@@ -1,4 +1,3 @@
-
 from typing import List
 
 from aiohttp import web
@@ -13,7 +12,7 @@
     TaskOrderableQuery,
     TaskPathSchema,
     TaskQuery,
-    TaskUpdate
+    TaskUpdate,
 )
 
 routes = web.RouteTableDef()

diff --git a/tests/example/endpoints_additional.py b/tests/example/endpoints_additional.py
@@ -14,7 +14,7 @@
     TaskPathSchema,
     TaskPathSchema2,
     TaskQuery,
-    TaskUpdate
+    TaskUpdate,
 )
 
 additional_routes = web.RouteTableDef()

diff --git a/tests/example/models.py b/tests/example/models.py
@@ -68,6 +68,7 @@ class TaskPathSchema:
 
 # Additional models for testing
 
+
 @dataclass
 class TaskPathSchema2:
     task_id: str = fields.uuid_field(required=True, description="Task ID")