[Numpy-discussion] Help!!! Docstrings overrun by markup crap.

Ralf Gommers ralf.gommers@googlemail....
Mon Mar 22 10:12:05 CDT 2010


On Mon, Mar 22, 2010 at 7:07 AM, Charles R Harris <charlesr.harris@gmail.com
> wrote:

>
>
> On Sun, Mar 21, 2010 at 8:53 AM, Ralf Gommers <ralf.gommers@googlemail.com
> > wrote:
>
>>
>>
>> On Sun, Mar 21, 2010 at 10:41 PM, <josef.pktd@gmail.com> wrote:
>>
>>> > 3. List with multi-line items are broken only inside the
>>> Parameters/Returns
>>> > sections. This is a bug and simply needs to be fixed. (this would fix
>>> both
>>> > of your examples)
>>>
>>> Does this mean if this bug gets fixed, then we wouldn't need the extra
>>> empty lines between list items?
>>>
>>
>> Yes. The following works in the Notes section, but not in Parameters:
>> - item one
>> - item two
>>   this is a multi-line item
>> - item 3
>>
>>
>>>
>>> Currently, the rendering in the doc editor view for item lists has
>>> also wrong indentation
>>> http://docs.scipy.org/numpy/docs/numpy.ndarray.transpose/
>>> but the html looks ok
>>>
>>> http://docs.scipy.org/doc/numpy/reference/generated/numpy.ndarray.transpose.html
>>>
>>
>> Html looks fine indeed. It should still look like that once that bug is
>> fixed.
>>
>>
> Could you open a ticket for this? We need to track it somewhere.
>

It's already a pydocweb ticket:
http://code.google.com/p/pydocweb/issues/detail?id=46
The html in the compiled docs looks decent so I don't think it's a numpy
issue.
It's just hard to get markup right if the wiki doesn't work (usually the big
red letters indicate actual human error).

Cheers,
Ralf
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://mail.scipy.org/pipermail/numpy-discussion/attachments/20100322/37f12220/attachment.html 


More information about the NumPy-Discussion mailing list