On 5/15/07, Alan G Isaac <[EMAIL PROTECTED]> wrote:
On Tue, 15 May 2007, Charles R Harris apparently wrote:
> 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.
OK, I see.
To control this we need a very small change in output.
Instead of::
<dl class="docutils">
<dt><code class="link">myvar</code>: mytype</dt>
<dd>my explanation</dd>
</dl>
I think (as long as the colon is ok) we just need::
<dl class="docutils parameterlist">
<dt>
<code class="link parameter">myvar</code>:
<span class="parametertype">mytype</span>
</dt>
<dd>my explanation</dd>
</dl>
This actually seems a very appropriate change for epydoc and
fully backwards compatible. I'll copy this to Ed Loper and
see if he will consider making this change. (I'm not sure he
is monitoring this discussion any longer.)
What I would like it to look like, except for the type stuff, is attached.
Chuck
Title: bar
Module barsource code
|
|
foo(var1,
var2,
long_variable_name)
one-line summary or signature. |
source code
|
|
|
one-line summary or signature.
Decription
Several sentences providing an extended description.
Parameters:
- var1 : type information
- Explanation
- var2 : type information
- Explanation
- long_variable_name
- Explanation
Returns:
- named : type
- Explanation
- list :
- Explanation
- of :
- Explanation
- outputs :
- even more explaining
Other Parameters:
- only_seldom_used_keywords : type
- Explanation
- common_parametrs_listed_above : type
- Explanation
See Also:
otherfunc- relationship (optional)
newfunc- relationship (optional)
Notes
Notes about the implementation algorithm (if needed).
This can have multiple paragraphs as can all sections.
Examples
examples in doctest format
>>> a=[1,2,3]
>>> [x + 3 for x in a]
[4,5,6]
|
|
_______________________________________________
Numpy-discussion mailing list
[email protected]
http://projects.scipy.org/mailman/listinfo/numpy-discussion
