E
ES
I am thinking of starting something up to entirely
replace (not fix) RDoc, so I need some input.
There is only so much data to be gathered from the
source code and RDoc is fairly good at that. What
it is not good at is keeping things simple while
producing a usable data structure. Those are things
that would be automatically corrected. Are there
any other 'mechanical' things that need to be fixed?
The main task would probably be to revise the format
of the documentation itself: allow 'keywords' for a
return value, parameters, examples and so on to build
more meaningful and consistent documentation while
keeping the format as natural as possible. Any good
requests for this part?
The third thing is migration... should probably allow
converting to any new documentation format by just
running a script or then support the old format out
of the box.
So, make a list.
E
replace (not fix) RDoc, so I need some input.
There is only so much data to be gathered from the
source code and RDoc is fairly good at that. What
it is not good at is keeping things simple while
producing a usable data structure. Those are things
that would be automatically corrected. Are there
any other 'mechanical' things that need to be fixed?
The main task would probably be to revise the format
of the documentation itself: allow 'keywords' for a
return value, parameters, examples and so on to build
more meaningful and consistent documentation while
keeping the format as natural as possible. Any good
requests for this part?
The third thing is migration... should probably allow
converting to any new documentation format by just
running a script or then support the old format out
of the box.
So, make a list.
E