Issue 13489: collections.Counter doc does not list added version (original) (raw)

Created on 2011-11-27 05:01 by sligocki, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Messages (6)
msg148443 - (view)	Author: Shawn Ligocki (sligocki)	Date: 2011-11-27 05:01
collections.Counter doc does not list added version: http://docs.python.org/library/collections.html It appears to only have been added in 2.7 (while the rest of the doc says it is valid since 2.4)
msg148444 - (view)	Author: Ezio Melotti (ezio.melotti) *	Date: 2011-11-27 05:18
I see the note just after the sausage example and in the table at the top of the page, from the link you provided.
msg148445 - (view)	Author: Shawn Ligocki (sligocki)	Date: 2011-11-27 06:43
Ah, I see, it seems like that would be better suited directly after the section title, don't you?
msg148446 - (view)	Author: Ezio Melotti (ezio.melotti) *	Date: 2011-11-27 06:56
The convention is to put the note at the end of the section. For this specific case the section about Counter is immediately followed by the documentation of its methods, so it's indeed hard to notice. Maybe a different CSS would make this more evident.
msg148618 - (view)	Author: Shawn Ligocki (sligocki)	Date: 2011-11-29 21:43
It doesn't seem like the styling is the issue, but the placement. You say that the standard style is to put this at the end of the section, is there somewhere it would be appropriate to bring this up for discussion? I think it would be much more intuitive if it was always placed right after the section name.
msg148620 - (view)	Author: Raymond Hettinger (rhettinger) *	Date: 2011-11-29 22:08
FWIW, the version added is also prominently shown at the top of the page: http://docs.python.org/library/collections.html#module-collections I don't think the CSS should be changed or that versionadded should become more prominent -- this is usually one of the least important parts of the documentation for a function or class.