On 5/15/07, Charles R Harris <[EMAIL PROTECTED]> wrote:
On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote:
>
> On Tue, 15 May 2007, Charles R Harris apparently wrote:
> > If a CSS can set all the font styles, item spacing, and
> > treatment of explanatory text, that would be the more
> > flexible route.
>
> I'm not sure what "treatment" meams here,
> but if it is a matter of font decisions or spacing,
> the answer should be yes.
The item in a consolidated list is divided into three parts: name, type,
explanation. I see no way in the CSS to control the display of those parts,
although it might be an undocumented feature. I basically want it to look
like a definition list with maybe the current default for type, which puts
it in parenthesis.
> If we can also make SeeAlso generate links to the
> > referenced routines I will be very satisfied.
>
> epydoc supports documentation cross-reference links.
> I think you get what you want (if I understand) just
> but putting the name in back ticks, `like_this`.
> That will give me a link to the like_this function
> in the same module (and maybe anywhere in the package,
> but I'm not sure).
Yes, I just noticed that. One less thing to worry about.
Problems with the include HOWTO_DOCUMENT.txt file:
1) Needs to show, __docformat__ = "restructuredtext en", generates errors
otherwise.
2) Consolidated field *must* have a type if : is included in the item.
3) Notes and Examples are moved to the top.
4) :OtherParameters: is not a recogized type.
I am willing to correct this stuff, but <rant> I really don't think these
things should be committed without anyone apparently running epydoc and
looking at the output. </rant>
I've attached an html file generated by pasting the HOWTO_DOCUMENT.txt
markup into a fictitious foo function.
Chuck
Title: foo
Module foosource code
|
|
foo(var1,
var2,
long_variable_name)
one-line summary or signature. |
source code
|
|
|
one-line summary or signature.
Several sentences providing an extended description.
Notes about the implementation algorithm (if needed).
This can have multiple paragraphs as can all sections.
examples in doctest format
>>> a=[1,2,3]
>>> [x + 3 for x in a]
[4,5,6]
- Parameters:
var1 (type information) - Explanationvar2 (type information) - Explanationlong_variable_name, - Returns:
- named : type
- Explanation
- list :
- Explanation
- of :
- Explanation
- outputs :
- even more explaining
See Also:
- otherfunc : relationship (optional)
- newfunc : relationship (optional)
|
|
_______________________________________________
Numpy-discussion mailing list
Numpy-discussion@scipy.org
http://projects.scipy.org/mailman/listinfo/numpy-discussion
