Updating epydoc documentation.

上级 899c9a07
...@@ -7,8 +7,7 @@ ...@@ -7,8 +7,7 @@
# The list of objects to document. Objects can be named using # The list of objects to document. Objects can be named using
# dotted names, module filenames, or package directory names. # dotted names, module filenames, or package directory names.
# Alases for this option include "objects" and "values". # Alases for this option include "objects" and "values".
#modules: *.py, gof/*.py, tlearn/*.py, joseph/*.py, scipy, numpy modules: *.py, gof/*.py, joseph/*.py, tlearn/*.py, scipy, numpy
modules: *.py, gof/*.py, tlearn/*.py, scipy, numpy
# The type of output that should be generated. Should be one # The type of output that should be generated. Should be one
# of: html, text, latex, dvi, ps, pdf. # of: html, text, latex, dvi, ps, pdf.
...@@ -136,7 +135,7 @@ dotpath: /usr/bin/dot ...@@ -136,7 +135,7 @@ dotpath: /usr/bin/dot
# The name of one or more pstat files (generated by the profile # The name of one or more pstat files (generated by the profile
# or hotshot module). These are used to generate call graphs. # or hotshot module). These are used to generate call graphs.
#pstat: sparse.pstat pstat: autotest.pstat
# Specify the font used to generate Graphviz graphs. # Specify the font used to generate Graphviz graphs.
# (e.g., helvetica or times). # (e.g., helvetica or times).
......
...@@ -7,8 +7,7 @@ ...@@ -7,8 +7,7 @@
# The list of objects to document. Objects can be named using # The list of objects to document. Objects can be named using
# dotted names, module filenames, or package directory names. # dotted names, module filenames, or package directory names.
# Alases for this option include "objects" and "values". # Alases for this option include "objects" and "values".
#modules: *.py, gof/*.py, tlearn/*.py, joseph/*.py modules: *.py, gof/*.py, joseph/*.py, tlearn/*.py
modules: *.py, gof/*.py, tlearn/*.py
# The type of output that should be generated. Should be one # The type of output that should be generated. Should be one
# of: html, text, latex, dvi, ps, pdf. # of: html, text, latex, dvi, ps, pdf.
...@@ -136,7 +135,7 @@ dotpath: /usr/bin/dot ...@@ -136,7 +135,7 @@ dotpath: /usr/bin/dot
# The name of one or more pstat files (generated by the profile # The name of one or more pstat files (generated by the profile
# or hotshot module). These are used to generate call graphs. # or hotshot module). These are used to generate call graphs.
#pstat: sparse.pstat pstat: autotest.pstat
# Specify the font used to generate Graphviz graphs. # Specify the font used to generate Graphviz graphs.
# (e.g., helvetica or times). # (e.g., helvetica or times).
......
#!/bin/sh #!/bin/sh
# python -m profile -o autotest.pstat autotest.py
epydoc --config epydoc-fast epydoc --config epydoc-fast
#!/bin/sh #!/bin/sh
python -m profile -o autotest.pstat autotest.py
epydoc --config epydoc epydoc --config epydoc
...@@ -17,7 +17,7 @@ __all__ = ['Op', ...@@ -17,7 +17,7 @@ __all__ = ['Op',
def constructor(op_cls): def constructor(op_cls):
"""Make an Op look like a Result-valued function.""" """Make an Op look like a L{Result}-valued function."""
def f(*args, **kwargs): def f(*args, **kwargs):
op = op_cls(*args, **kwargs) op = op_cls(*args, **kwargs)
if len(op.outputs) > 1: if len(op.outputs) > 1:
...@@ -28,12 +28,12 @@ def constructor(op_cls): ...@@ -28,12 +28,12 @@ def constructor(op_cls):
class Op(object): class Op(object):
""" """
Op represents a computation on the storage in its 'inputs' slot, L{Op} represents a computation on the storage in its 'inputs' slot,
the results of which are stored in the Result instances in the the results of which are stored in the L{Result} instances in the
'outputs' slot. The owner of each Result in the outputs list must 'outputs' slot. The owner of each L{Result} in the outputs list must
be set to this Op and thus any Result instance is in the outputs be set to this L{Op} and thus any L{Result} instance is in the outputs
list of at most one Op, its owner. It is the responsibility of the list of at most one L{Op}, its owner. It is the responsibility of the
Op to ensure that it owns its outputs and it is encouraged (though L{Op} to ensure that it owns its outputs and it is encouraged (though
not required) that it creates them. not required) that it creates them.
""" """
......
Markdown 格式
0%
您添加了 0 到此讨论。请谨慎行事。
请先完成此评论的编辑!
注册 或者 后发表评论