CI User Guide question

[eluser]jedd[/eluser]
Derek, perhaps some guidelines might be handy here. I know you're busy, but there's at least two people here, at the moment, who'd be happy to work through the manual and standardise the function definitions (for example) for you. I'd be happy to a bunch of pages, and provide diff patches - assuming that's easy enough for you to push back into svn - and I'm confident jdfwarrior would be equally happy with, and adept at, using those same tools too.

The very fact that some pages contain function definitions that list each of the parameters suggests that it's an option at least one of you guys likes the look of.

So, if you give the nod there, I'm sure we'd be willing to do the actual footwork, as it were. What a deal, eh?!

For my own part, I found generating the patches very easy, just using the github hosted replica of your current svn as my base.

But, to return the guidelines subject -- since it aligns nicely with jdfwarrior's point about consistency -- this seems like a good forum to ask, dare I say discuss, your / EL's preferences here, so we know what kind of patches are (not) worth submitting.

I'll start the ball rolling with this one.

'This example code produces this output...' -- about half the time, this is done within the same [ code ] tags that the actual code is, and sits next to a // comment. The other half of the time it's in the following paragraph and in a normal font. The obvious question -- is it worth my time to generate a patch set of that size and nature?