Browse Source

Fixed function docs.

Rafał Pitoń 11 years ago
parent
commit
55649e2326
2 changed files with 14 additions and 14 deletions
  1. 5 5
      docs/developers/decorators.rst
  2. 9 9
      docs/developers/validators.rst

+ 5 - 5
docs/developers/decorators.rst

@@ -12,7 +12,7 @@ misago.core.decorators
 require_POST
 ------------
 
-:py:function:`misago.core.decorators.require_POST`
+:py:func:`misago.core.decorators.require_POST`
 
 Function that checks if request made to access view is POST. If it's not, decorator renders ''wrong_way.html'' template and returns it in 405-coded response. This is its only difference to Django's counterpart.
 
@@ -24,7 +24,7 @@ misago.core.errorpages
 shared_403_exception_handler
 ----------------------------
 
-:py:function:`misago.core.errorpages.shared_403_exception_handler`
+:py:func:`misago.core.errorpages.shared_403_exception_handler`
 
 If your project has different error handler for 403 errors defined, you can use this decorator to make your function shared handler between Misago and other views. This will make Misago handle 403 exceptions coming from under its path while leaving alone exceptions coming from your site.
 
@@ -32,7 +32,7 @@ If your project has different error handler for 403 errors defined, you can use
 shared_404_exception_handler
 ----------------------------
 
-:py:function:`misago.core.errorpages.shared_404_exception_handler`
+:py:func:`misago.core.errorpages.shared_404_exception_handler`
 
 Same as above but for custom 404 error handler.
 
@@ -44,7 +44,7 @@ misago.users.decorators
 deny_authenticated
 ------------------
 
-:py:function:`misago.users.decorators.deny_authenticated`
+:py:func:`misago.users.decorators.deny_authenticated`
 
 This decorator will block requests made to view if user is authenticated, displaying page with friendly error message in its stead.
 
@@ -52,6 +52,6 @@ This decorator will block requests made to view if user is authenticated, displa
 deny_guests
 -----------
 
-:py:function:`misago.users.decorators.deny_guests`
+:py:func:`misago.users.decorators.deny_guests`
 
 This decorator will block requests made to view if user is not authenticated, displaying page with friendly error message in its stead.

+ 9 - 9
docs/developers/validators.rst

@@ -38,7 +38,7 @@ Function that takes email address and runs content, availability and ban check v
 validate_email_banned
 ---------------------
 
-:py:function:`misago.users.validators.validate_email_banned`
+:py:func:`misago.users.validators.validate_email_banned`
 
 Function that accepts email string as its only argument and raises Validation error if it's banned.
 
@@ -54,7 +54,7 @@ Callable instance of :py:class:`django.core.validators.EmailValidator` that chec
 validate_password
 -----------------
 
-:py:function:`misago.users.validators.validate_password`
+:py:func:`misago.users.validators.validate_password`
 
 Function that takes plaintext password and runs length and complexity validation in this order via calling dedicated validators.
 
@@ -62,7 +62,7 @@ Function that takes plaintext password and runs length and complexity validation
 validate_password_complexity
 ----------------------------
 
-:py:function:`misago.users.validators.validate_password_complexity`
+:py:func:`misago.users.validators.validate_password_complexity`
 
 Validates password complexity against tests specified in ``password_complexity`` setting.
 
@@ -70,7 +70,7 @@ Validates password complexity against tests specified in ``password_complexity``
 validate_password_length
 ------------------------
 
-:py:function:`misago.users.validators.validate_password_length`
+:py:func:`misago.users.validators.validate_password_length`
 
 Validates password length and raises ValidationError if specified plaintext password is shorter than ``password_length_min``.
 
@@ -78,7 +78,7 @@ Validates password length and raises ValidationError if specified plaintext pass
 validate_username
 -----------------
 
-:py:function:`misago.users.validators.validate_username`
+:py:func:`misago.users.validators.validate_username`
 
 Function that takes username and runs content, length, availability and ban check validation in this order via calling dedicated validators.
 
@@ -86,7 +86,7 @@ Function that takes username and runs content, length, availability and ban chec
 validate_username_available
 ---------------------------
 
-:py:function:`misago.users.validators.validate_username_available`
+:py:func:`misago.users.validators.validate_username_available`
 
 Function that accepts username string as its only argument and raises ValidationError if it's already taken.
 
@@ -94,7 +94,7 @@ Function that accepts username string as its only argument and raises Validation
 validate_username_banned
 ------------------------
 
-:py:function:`misago.users.validators.validate_username_banned`
+:py:func:`misago.users.validators.validate_username_banned`
 
 Function that accepts username string as its only argument and raises Validation error if it's banned.
 
@@ -102,7 +102,7 @@ Function that accepts username string as its only argument and raises Validation
 validate_username_content
 -------------------------
 
-:py:function:`misago.users.validators.validate_username_content`
+:py:func:`misago.users.validators.validate_username_content`
 
 Function that accepts username string as its only argument and raises Validation error if username contains disallowed characters (eg. those that are not matched by ``[0-9a-z]+`` regex).
 
@@ -110,6 +110,6 @@ Function that accepts username string as its only argument and raises Validation
 validate_username_length
 ------------------------
 
-:py:function:`misago.users.validators.validate_username_length`
+:py:func:`misago.users.validators.validate_username_length`
 
 Function that accepts username string as its only argument and raises Validation error if it's shorter than ``username_length_min`` setting or longer than ``username_length_max`` setting.