[wp-hackers] Fixing Bugs

[jacobsantos at branson.com]

Sweet idea!

A lot of the internals of WordPress, the real good stuff, isn't 
documented. Which sucks. It would be cool to have a phpDoc site for 
plugin and internals developers to look at. Besides the sites that try 
to do that manually.

Stephane Daury wrote:
>
> One way we use at work that has helped with the "wontfix/invalid" bugs 
> tracking in the long term is to simply refer to the Trac ticket# using 
> the @see phpdoc keyword around the involved source code, coupled with 
> an explanation in the ticket.
>
> It's an easy way of correlating these issues in our generated docs 
> without adding too much comment content to the source.
>
> If nothing else, it helps the developers to tame duplicate bug entries 
> and addressing.
>
> I'm not going to preach for proper inline phpdocs/natural docs here, 
> but it sure is helping us a lot with rather painlessly documenting our 
> APIs.
>
> Stephane
>
>
> On Aug 27, 2007, at 16:30, Martin at Cleaver.org wrote:
>
>> Indeed, unless a system gets documentation, to explain and put rigour 
>> into
>> the model of how it should work, bugs will continue to get through the
>> cracks.
>>
>> Martin.
>>
>> On 8/27/07, jacobsantos at branson.com <jacobsantos at branson.com> wrote:
>>>
>>> I like this idea, but I think it has more to do with users submitting
>>> patches for bugs. Which I think is what the bug hunts are all about,
>>> finding and submitting patches.
>>>
>>> I also think that reasons should be given when closing as invalid or
>>> wontfix. It is good bug handling in my opinion and something that won't
>>> annoy those who submit bugs. Some bugs marked as won't fix or invalid
>>> mean that the bug is external to the application that can't be fixed
>>> easily. However, making it clear what the developers intention was 
>>> would
>>> go a long way.
>>>
>>> There will never be any release in any application where everything
>>> works. However, fixing what bugs we have now would be an awesome idea!
>>> Documenting the code should go along with this idea.
>>>
>>> Jacob Santos
>>>
>>> Geoffrey Sneddon wrote:
>>>> The number in bugs in WP has grown steadily over several years, yet
>>>> the number of unfixed ones increasing quicker still. We need a release
>>>> that is stable. We need a release where everything _works_. Can we
>>>> have one release which includes _nothing_ but bug fixes. There are 409
>>>> open bugs according to trac (and I expect there are others marked as
>>>> wontfix/invalid without reason). There are some massively annoying
>>>> bugs for users, not least things like being unable to use IRIs in
>>>> sanitised content (#4570, target 2.4).
>>>>
>>>>
>>>>
>>>> - Geoffrey Sneddon
>>>>
>>>>
>>>> _______________________________________________
>>>> wp-hackers mailing list
>>>> wp-hackers at lists.automattic.com
>>>> http://lists.automattic.com/mailman/listinfo/wp-hackers
>>>>
>>>>
>>>>
>>>
>>> _______________________________________________
>>> wp-hackers mailing list
>>> wp-hackers at lists.automattic.com
>>> http://lists.automattic.com/mailman/listinfo/wp-hackers
>>>
>>
>>
>>
>> -- 
>> Martin at Cleaver.org
>> _______________________________________________
>> wp-hackers mailing list
>> wp-hackers at lists.automattic.com
>> http://lists.automattic.com/mailman/listinfo/wp-hackers
>
> _______________________________________________
> wp-hackers mailing list
> wp-hackers at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-hackers
>
>
>