jiuyuan
/
test_ok1
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[svn r38449] removed DONE issues, added one more (sources page) 

and comments.

--HG--
branch : trunk
This commit is contained in:
hpk 2007-02-11 12:14:44 +01:00
parent b7b9ff2b71
commit 609b34d586
1 changed files with 5 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
py/apigen/todo.txt
View File

@ -1,26 +1,7 @@
* when listing the methods of a class:
special "__*__" methods should come last except for __init__
which comes first
* source page headers should read:
DONE
* the page header should read:
py.path.local API documentation [rev XYZ]
instead of
api documentation for path.local
DONE, title changed and if possible (read: if source file in SVN) rev is
retrieved and added
* have the py/doc/ and apigen page layout have
an api and source link in the menu bar
(e.g.: home doc api source contact getting-started issue)
DONE
py/apigen sources [rev XXX]
* function view:
@ -37,31 +18,8 @@
DONE, but please review if you like it like this...
* can it be avoided that py.execnet.Channel shows up as a
primary object but still have it documented/linked from
remote_exec()'s "return value"?
DONE: if you set an attribute __hide_from_nav__ to True on an
object somehow, it is hidden from the navigation
* class attributes are not "properties". can they get their
section?
DONE: renamed title to 'class attributes and properties'
(as discussed)
* stacktraces: a lot are "duplicates" like:
/home/hpk/py-trunk/py/test/rsession/hostmanage.py - line 37
/home/hpk/py-trunk/py/test/rsession/hostmanage.py - line 37
/home/hpk/py-trunk/py/test/rsession/hostmanage.py - line 37
even though they may reference different stackframes,
i think we should by default strip out these duplicates,
this would also reduce the generated html files, right?
DONE, although I'm not happy with it... I'd rather only display call sites
from calls in the test somehow or something...
XXX it's nice but can you keep the docstring visible when
more information is displayed/toggled?
* allow for flexibility regarding linking from
py/doc/*.txt documents to apigen with respect