#11 not closed <dl> break html lists

closed-rejected
5
2003-01-14
2003-01-11
Anonymous
No

This docstring will render incorrectly:
"""
Method summary

@param A: some arg A
@type A: int

some A description:
- A is foo
- A must be bar
- A can't be buz
"""

In 'some A description' <ul> list will be broken,
because there are not </dl> after type definition and
new paragraph

Discussion

  • Edward Loper

    Edward Loper - 2003-01-14

    Logged In: YES
    user_id=195958

    According to the epytext markup language, every "@foo"
    starts a new
    field, which can contain multiple paragraphs, lists, etc.
    So in the
    docstring that you gave, epytext sees everything
    from "int" to "buz"
    as part of the *type* of A. So it renders it where it puts
    types
    (n.b. in the current html output, having lists etc. in the
    type
    description doesn't make much sense; perhaps that
    should be fixed.
    But I don't think that's the problem you're reporting).

    Instead, you should put the description of A in
    the "@param" field.
    I.e., you should rewrite your docstring to say something
    like:

    """
    Method summary

    @param A: some arg A. some A description:
    - A is foo
    - A must be bar
    - A can't be buz
    @type A: int
    """

     
  • Edward Loper

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

Log in to post a comment.