Re: Documenting new features: built-in obsolescence of the "versionadded" tag.

2010-07-26 Thread Jacob Kaplan-Moss
On Mon, Jul 26, 2010 at 9:44 AM, Ramiro Morales wrote: > Richard has opened ticket [1]14000 for tracking work on this. 14,000! > One additional question: Should the 'versionchanged' notes > get the same treatment? Yeah, I think so. Remember: we might need to edit/rewrite

Re: Documenting new features: built-in obsolescence of the "versionadded" tag.

2010-07-26 Thread Ramiro Morales
On Fri, Jul 23, 2010 at 4:49 PM, Jacob Kaplan-Moss wrote: > On Fri, Jul 23, 2010 at 9:37 AM, Jeremy Dunck wrote: >> I think maybe the rendering can just be altered to ignore tags with >> the old values? > > Actually, I think I'd rather just remove them --

Re: Documenting new features: built-in obsolescence of the "versionadded" tag.

2010-07-23 Thread Russell Keith-Magee
On Sat, Jul 24, 2010 at 6:13 AM, Justin Lilly wrote: > While I know it comes with extra work, I think the contents of the > versionadded bits need to be reworked into the body of text. While I > can't remember any specific examples, I remember reading docs a few > times

Re: Documenting new features: built-in obsolescence of the "versionadded" tag.

2010-07-23 Thread Justin Lilly
While I know it comes with extra work, I think the contents of the versionadded bits need to be reworked into the body of text. While I can't remember any specific examples, I remember reading docs a few times and coming across versionadded statements that were at the bottom of their section

Re: Documenting new features: built-in obsolescence of the "versionadded" tag.

2010-07-23 Thread Jacob Kaplan-Moss
On Fri, Jul 23, 2010 at 9:37 AM, Jeremy Dunck wrote: > I think maybe the rendering can just be altered to ignore tags with > the old values? Actually, I think I'd rather just remove them -- plenty of people (including me) read the docs in plain text, and the "versionadded" is

Re: Documenting new features: built-in obsolescence of the "versionadded" tag.

2010-07-23 Thread Gregor Müllegger
That would be also my intend. We could keep the tags in the documentation but could stop the output in the HTML generation. 2010/7/23 Jeremy Dunck : > On Fri, Jul 23, 2010 at 11:18 AM, Tobias McNulty > wrote: >> I agree.  It's a little odd seeings

Re: Documenting new features: built-in obsolescence of the "versionadded" tag.

2010-07-23 Thread Jeremy Dunck
On Fri, Jul 23, 2010 at 11:18 AM, Tobias McNulty wrote: > I agree.  It's a little odd seeings things flagged "New" that have been > around since 1.0.  I also like your proposal of removing the notes for > unsupported versions. > Tobias I think maybe the rendering can just

Re: Documenting new features: built-in obsolescence of the "versionadded" tag.

2010-07-23 Thread Tobias McNulty
I agree. It's a little odd seeings things flagged "New" that have been around since 1.0. I also like your proposal of removing the notes for unsupported versions. Tobias On Fri, Jul 23, 2010 at 12:06 PM, richardbarran < richardbar...@googlemail.com> wrote: > Hi everybody, > The Django

Documenting new features: built-in obsolescence of the "versionadded" tag.

2010-07-23 Thread richardbarran
Hi everybody, The Django documentation places a strong emphasis on highlighting new/ changed features with lines such as: "New in Django 1.0: Please, see the release notes" Such comments are a useful mental reminder when scanning through the docs, they do however have one downside: built-in