Is there a need to mention non-final release version in 'versionadded' directives?

20 views
Skip to first unread message

Tshepang Lekhonkhobe

unread,
Jan 27, 2013, 12:42:40 PM1/27/13
to pylons...@googlegroups.com
Could we simply remove this? Does a user need to know which exact alpha (or beta) release an API was added? I think such detail is a bit of overkill for 'versionadded' Sphinx directives; it's better left in VCS history.

ok: added in 1.4b2
better: added in 1.4

Tshepang Lekhonkhobe

unread,
Feb 3, 2013, 5:29:06 AM2/3/13
to pylons...@googlegroups.com
anyone?

Mike Orr

unread,
Feb 3, 2013, 1:48:31 PM2/3/13
to pylons...@googlegroups.com
It can go either way depending on context. The first couple versions
of Pyramid needed it because major API changes were being made between
development versions, so it was necessary to tie to the version with
the right API in order to develop your application. Some other
projects have long beta periods and there's not as much distinction
between betas and final, so the betas get used in applications. I
guess this mostly happens with small libraries like WebHelpers and
Routes, where most changes are adding a little incremental feature.

With Pyramid not undergoing major structural changes now, it would be
fine to say "added in 1.4", and people can look at the Changelog if
they want to know the specific beta.
Reply all
Reply to author
Forward
0 new messages