As a newcomer in Moodle code development, I search for informations in the http://docs.moodle.org/en/Developer_documentation
and more specifically to
" This section is for documentation of specific components of the existing core Moodle code. Discussion of components that are under discussion or in development can be found in the Developer notes or on the Roadmap. "
In this section there is two items related to this forum (most of them have been written by Gustav Delius.
Because writing documentation is not a priority when there is so much new code to write,test and debug there was few informations on the code flow in the different quiz or question modules.
I submit to this forum and bug reports various improvments on calculated questiontype which is one of the most complex questiontype.
However I realize that the Quiz forum is not the right place to get structured information at the level necessary to explain my code proposals.
To reassure myself and those who are in charge of modifying the Moodle (Tim, Howard etc.), I decide to use the developper docs to document the code flow as I understand it, so that other developpers could correct my understandings and my code modifications could be implemented if they appear to be "safe".
I do not use developper notes because there was no links to question types
As there was no page written for calculated question type, any "no error" documentation will be potentially useful.
This is a beginning...
I haved also these email exchanges with Tim and Howard:
New developments should be documented here:
However, you must consider the possibility that the discussion is better carried out in the Quiz forum to increase their visibility. Up to you on that point.
On 19 Jun 2006, at 13:42, Pierre Pichet wrote:
Thanks for your remarks.
Could you explain IIRC there is an area for proposed and in- progress development work.??
Howard Miller wrote:Tim / Pierre,
IIRC there is an area for proposed and in-progress development work.
I don't wish to be overly critical, but I have just skimmed through the documentation you have provided and find it quite confusing - and I *wrote* a lot of this stuff. The problem, as Tim notes, is that while it masquerades as documentation for the existing system, a lot of it is about the *problems* with the latest system. I can guarantee that this will confuse new users reading this.
At the end of the day I am not precious about any of this code and would be more than happy to see it enhanced. However, it is Tim's call if these modifications to the core quiz functionality should be made and meantime it is how it is and the discussion about proposed new features should be moved somewhere else.
I will be happy to spend some time adding to and enhancing Pierre's documentation to reflect the current state until such time as it changes.
On 19 Jun 2006, at 11:02, T.J.Hunt wrote:Pierre Pichet wrote:Hi Tim and Howard,Improving correctly calculated question require that calculated
question complexity be well known before implementing new code
issues.The docs appears to me to be the right place to expose this
complexity and suggest improvements which when ready, should be
submit to bugs with an "announcement" in the quiz forum so that
others could add their suggestions or commentaries. This is why I am
writing done on the developer docs.http://docs.moodle.org/en/Question_engine#Question_types and the
links in the template at the right of it.
Am I doing it the right way ?
Yes, the Docs wiki is the right place for this sort of thing.
However, the developer docs should be firstly a description of how the
code works now.
When you are writing a proposal for how the code should work differently
in the future, you should mark that section so that it is clear that it
is a future proposal, and add your name, so we know whose proposal it