Re: [Codenarc-developer] documenting .apt rule descriptions with "since .011" or on wiki
Brought to you by:
chrismair
Menu
▾
▴
Re: [Codenarc-developer] documenting .apt rule descriptions with "since .011" or on wiki
|
From: Hamlet D. <ham...@ca...> - 2010-11-10 06:27:44
|
Do whatever you want with the docs. Just let me know what you did so I can update the "create-rule" script to do the same. -- Hamlet D'Arcy ham...@ca... Message I refined the formatting of all of those "New in 0.11" messages, so that they looked ok when the web pages are rendered. I also changed them all to "Since CodeNarc 0.11" so that we don't have to update them when we put out 0.12, etc.. I also reorderd the new rule documentation to be in alphabetical order. Otherwise it is difficult to find rule documentation for a specific rule, especially within a big ruleset like "basic". Please do that when you add new rules. I am still considering adding an index or table of contents for some of the bigger rulesets, or perhaps an index for all of the rules (if I can generate it from a script). Thanks. Chris -----Original Message----- From: Hamlet D'Arcy [mailto:ham...@gm...] Sent: Tuesday, November 09, 2010 2:47 PM To: chr...@wa...; Cod...@li... Subject: Re: [Codenarc-developer] documenting .apt rule descriptions with "since .011" or on wiki The .apt files are now updated with "new in 0.11" -- Hamlet D'Arcy ham...@gm... On Tue, Nov 9, 2010 at 2:31 PM, < chr...@wa... > wrote: That sounds fine. I thought maybe you were suggesting updating and releasing the docs today, to get a one-week head start. But it sounds like we are on the same page. Hamlet DArcy < ham...@ca... > 11/09/2010 08:21 AM To chris mair < chr...@wa... > cc cod...@li... Subject Re: [Codenarc-developer] documenting .apt rule descriptions with "since .011" or on wiki Of course we will update the docs before the release. But I was thinking that next month maybe someone contributes a better description and then what do we do... we can just run mvn site and upload with no problems. -- Hamlet D'Arcy ham...@ca... If we are going to do the 0.11 release within the next week or so, can we just release it all together? Hamlet DArcy < ham...@ca... > 11/09/2010 07:53 AM To chris mair < chr...@wa... > cc cod...@li... Subject Re: [Codenarc-developer] documenting .apt rule descriptions with "since .011" or on wiki And if we document the .apt files with "since 0.11" then releasing new docs with changes from the head will not break anything. Let's do it. -- Hamlet D'Arcy ham...@ca... >> What do you think about documenting the new rules with "since 0.11" in the .apt file. That sounds like a great idea. >> Can the site documentation be updated outside of a build cycle? Yes, if needed, we could run the mvn site goal to rebuild the site, and then transfer the files up to the SourceForge directory, without doing a formal release. Chris Hamlet DArcy < ham...@ca... > 11/09/2010 07:41 AM To cod...@li... cc Subject [Codenarc-developer] documenting .apt rule descriptions with "since .011" or on wiki What do you think about documenting the new rules with "since 0.11" in the .apt file. That way they could be easily found. Can the site documentation be updated outside of a build cycle? -- Hamlet D'Arcy ham...@ca... ------------------------------------------------------------------------------ The Next 800 Companies to Lead America's Growth: New Video Whitepaper David G. Thomson, author of the best-selling book "Blueprint to a Billion" shares his insights and actions to help propel your business during the next growth cycle. Listen Now! http://p.sf.net/sfu/SAP-dev2dev_______________________________________________ Codenarc-developer mailing list Cod...@li... https://lists.sourceforge.net/lists/listinfo/codenarc-developer ForwardSourceID:NT000CE136 ForwardSourceID:NT000CE14E ForwardSourceID:NT000CE182 ------------------------------------------------------------------------------ The Next 800 Companies to Lead America's Growth: New Video Whitepaper David G. Thomson, author of the best-selling book "Blueprint to a Billion" shares his insights and actions to help propel your business during the next growth cycle. Listen Now! http://p.sf.net/sfu/SAP-dev2dev _______________________________________________ Codenarc-developer mailing list Cod...@li... https://lists.sourceforge.net/lists/listinfo/codenarc-developer ------------------------------------------------------------------------------ The Next 800 Companies to Lead America's Growth: New Video Whitepaper David G. Thomson, author of the best-selling book "Blueprint to a Billion" shares his insights and actions to help propel your business during the next growth cycle. Listen Now! http://p.sf.net/sfu/SAP-dev2dev _______________________________________________ Codenarc-developer mailing list Cod...@li... https://lists.sourceforge.net/lists/listinfo/codenarc-developer |
