[ http://jira.codehaus.org/browse/MCLOVER-47?page=comments#action_74386 ] Vincent Massol commented on MCLOVER-47: ---------------------------------------
Hi Franz, Thanks! I've not applied your patch yet because I'm still unsure about the "Examples" section: * I think I preferred the "Usage" version I had before (it was named "How to Use" before). You have modified the section headers to reflect the goals but I think it's better to make it a usage document rather than a goal documentation. Usage is more broad than goal reference doc as what users are interested in is to perform some tasks and we tell them how to chain the different goals and configuration to achieve this. I prefer it to be "use case" oriented rather than "goal"-oriented. * I'd like that all the "examples" you've separated be put back in the "Usage" section. This goes together with my first point. I still don't see anything that we would have to put in the Examples section right now so I'd like it empty. I don't mind if it raises a docck warning. I'd argue that it's docck which is faulty... ;-) (or maybe I don"t understand the split between usage and examples). We should raise this on the dev list but I will not lower the quality of the doc to avoid a docck warning ;-) If "Examples" were named "Usages" I wouldn't have any issue with it. I've just committed some small changes for now. We still need to find a solution for the Examples section... What I think will be nice is to have a TOC in the usage document. I'll try to find out if it's possible with APT. Thanks > review plugin documentation > --------------------------- > > Key: MCLOVER-47 > URL: http://jira.codehaus.org/browse/MCLOVER-47 > Project: Maven 2.x Clover Plugin > Issue Type: Task > Affects Versions: 2.2 > Reporter: John Tolentino > Assigned To: Vincent Massol > Fix For: 2.3 > > Attachments: MCLOVER-47-maven-clover-plugin-2.patch, > MCLOVER-47-maven-clover-plugin.patch > > > http://docs.codehaus.org/display/MAVEN/Maven+Plugin+Documentation -- This message is automatically generated by JIRA. - If you think it was sent incorrectly contact one of the administrators: http://jira.codehaus.org/secure/Administrators.jspa - For more information on JIRA, see: http://www.atlassian.com/software/jira
