from launchpad.codestandards import XXX

It may be useful to have XXX, TODO, and potentially a few other types of what I think we could sanely term 'Active code commentary'

A suggestion: we provide a function XXX now that does very little -- maybe even nothing. Developers can start using it now, and in the future the test suite and traceback integration can be added.

Bug 78471 suggests adding something to the 'make check' process that looks for comments themselves, rather than a special XXX function.

This probably should go into 'make lint' or 'make xxx' rather than 'make check'.

For my purposes, I need the following:

A program (could be stand-alone, make check, pydoctor, etc) that can search RF and display XXX comment blocks

   1. Display program name/path
   2. Display entire comment block containing XXX
   3.Tally up total XXX comment blocks in each program/module
   4. Must support multi-line XXX comment blocks

Curtis found a ready-made zope reporter which seems to do exactly what I specified above. He's going to attempt this for FiF.

http://cvs.zope.org/Zope3/utilities/XXXreport

I'll get this started with the XXXreport and XXXreport2html.py from zope. It's easy to modify. We may be able to stretch it to satisfy this bug's requirements.

Well I did not get to this on Friday day. It was an interesting problem so I worked on it after hours. Now the bash script and python formatter worked after a few minutes of changes, I didn't care for how it operated. So I wrote my own. I don't consider it done, but it did not take long to get something functional I have a sample at
https://devpad.canonical.com/~curtis/xxxreport.html.

I would do a few things differently from the report that I based this on:
1. Link all identified bugs to launchpad.
2. Identify the author and date of the bug and format them for easy reading.
3. Group the comments by file and include a summary of linked bugs.

Steve suggested we add the total count to cricket so we can track the volume of XXXs in the code over time. This would enable us to see if we're getting better or worse.

Cricket appears to be able to easily incorporate the data. Another option is to save the current number on each cron job (append to file) and then, using cron, run plot to produce the graph.

Re-target to 1.1.8 as Curtis had to work on more urgent things.

While I did not get the time to complete this issue I did add the CSV option. I have it linked from the HTML report I'm generating:
https://devpad.canonical.com/~curtis/xxxreport.html.

I have two steps left to do. Firstly, This must be integrated into cricket, and I'll be getting the assistance of others to do this. I think this implies I'll be writing a log analyser, possibly like the OOPS reports. Secondly, the HTML/CSV report work is poorly tested, and that must be addressed.

Moving this 1.1.10 since I had only half the development time.

Moving this back a release since I've taken on some extra tasks for 1.1.10.

This issue is not important enough to commit to a milestone, but it will be worked on as my schedule permits. There are some opportunities to make use of the forthcoming event logging API.

I'm lowering this because I have not worked on this for 9 months. When this is scheduled, It will have a high priority.

Since we decided that reporting the number XXX is more appropriate so that we cover non-python files, I think this bug can be closed as fix released.

However If we still want a cricket report, I'll keep this bug inprogress.

I think we can transfer the cricket portion over to the LOSAs to handle.

I'm marking this fix released. I'll open another bug regarding reporting the count of XXX in the tree in cricket.