| 1 |
A tool I use for Python code is epydoc, which is very similar to javadoc, except |
| 2 |
is uses reST (restructured text). So epydoc is my suggestion if Python is used |
| 3 |
for portage-ng (or part of it). |
| 4 |
|
| 5 |
On 18:55 Mon 29 Dec , Bart Lauwers wrote: |
| 6 |
> All the more reason to build the docs from the code directly with doxygen or |
| 7 |
> whatever. I'm pretty sure nobody writes code with the intent it doesn't get |
| 8 |
> used, from a coder standpoint having documentation helps feature acceptance. |
| 9 |
> |
| 10 |
> This feature probably is documented but since I can't find that documentation |
| 11 |
> quickly (i.e. just could find it in under 5 minutes) it might as well not |
| 12 |
> exist to the majority of devs. We s'port too many hidden feats. |
| 13 |
> |
| 14 |
> Anyway we've got lots of docs but were lacking a good taxonomy for them, do we |
| 15 |
> have any librarians helping the docs team? (cc'ing doc to get a reply about |
| 16 |
> this) |
| 17 |
> |
| 18 |
> So let me rephrase that portage docs need to be complete and up to date at all |
| 19 |
> times (at least an english version, devs should know enough english). Linking |
| 20 |
> the documentation to the code is the only way I can see this happen. |
| 21 |
> |
| 22 |
> Bart. |
| 23 |
> |
| 24 |
> On Monday 29 December 2003 00:02, Daniel Robbins wrote: |
| 25 |
> > |
| 26 |
> > This results in the current USE settings. I do think that not too many |
| 27 |
> > people know about auto-USE, so it is somewhat under-utilized. |
| 28 |
> |
| 29 |
> |
| 30 |
> -- |
| 31 |
> gentoo-portage-dev@g.o mailing list |
| 32 |
|
| 33 |
-- |
| 34 |
------------------------------ |
| 35 |
~~~~~ Jason A. Mobarak ~~~~~~~ |
| 36 |
~~ aether_at_gentoo_dot_org ~~ |
| 37 |
~~~~ jmob_at_unm_dot_edu ~~~~~ |
| 38 |
------------------------------ |
| 39 |
|
| 40 |
|
| 41 |
-- |
| 42 |
gentoo-portage-dev@g.o mailing list |
Archives