Hi,

These docs are in ReST (ReStructured Text) format, and each text file
> corresponds to a Web page on the official Django site.
>

source:
http://docs.djangoproject.com/en/dev/faq/general/#how-can-i-download-the-django-documentation-to-read-it-offline


On Sun, Sep 13, 2009 at 12:21 AM, Andrew R <andrew.rw.robin...@gmail.com>wrote:

>
> The built in templates and filters have formatted docstrings (``,
> =======, etc.). I don't see anywhere where this syntax is documented.
> Where can I find information on this.
>
> Example docstring:
> def yesno(value, arg=None):
>    """
>    Given a string mapping values for true, false and (optionally)
> None,
>    returns one of those strings accoding to the value:
>
>    ==========  ======================
> ==================================
>    Value       Argument                Outputs
>    ==========  ======================
> ==================================
>    ``True``    ``"yeah,no,maybe"``     ``yeah``
>    ``False``   ``"yeah,no,maybe"``     ``no``
>    ``None``    ``"yeah,no,maybe"``     ``maybe``
>    ``None``    ``"yeah,no"``           ``"no"`` (converts None to
> False
>                                        if no mapping for None is
> given.
>    ==========  ======================
> ==================================
>    """
>
> I would like to document my own filters and would like to understand
> the available syntax. Thanks.
>
> >
>


-- 
Tiago Serafim

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"Django users" group.
To post to this group, send email to django-users@googlegroups.com
To unsubscribe from this group, send email to 
django-users+unsubscr...@googlegroups.com
For more options, visit this group at 
http://groups.google.com/group/django-users?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to