#9 Can't use @param with :: at the end

closed-rejected
epytext (18)
5
2003-01-14
2002-12-16
Anonymous
No

I think that this line should be allowed, but right
now, i get a warning about improper paragraph
indentation:

"""
@param data: an array of the data to be plotted.
The format is as follow::
[ ["line name", xcoor, ycoor, xcoor,
ycoor, ...]
["line 2 name", xcoor, ycoor, xcoor,
ycoor, ...]
...
]
"""

Note that I put the "::" at the end of the first line
which should allow me to put some code below
that line...

Discussion

  • Edward Loper

    Edward Loper - 2003-01-14
    • status: open --> closed-rejected
     
  • Edward Loper

    Edward Loper - 2003-01-14

    Logged In: YES
    user_id=195958

    Literal blocks are required to be indented further than
    the paragraph that introduces them (that way, epytext
    can tell when they end). With the following docstring, I
    get no error:

    def f(data):
    """
    @param data: an array of the data to be plotted.
    The format is as follow::
    [ ["line name", xcoor, ycoor, xcoor, ycoor, ...]
    ["line 2 name", xcoor, ycoor, xcoor, ycoor, ...]
    ...
    ]
    """

    If you want no indentation in the output, then indent by
    1 space. (The indentation in the output is the
    indentation in the literal block minus the indentation of
    the para that introduced it minus one).

     

Log in to post a comment.