➜
This issue tracker has been migrated to GitHub,
and is currently read-only.
For more information,
see the GitHub FAQs in the Python's Developer Guide.
Created on 2012-10-12 07:22 by chris.jerdonek, last changed 2022-04-11 14:57 by admin.
| Messages (5) | |||
|---|---|---|---|
| msg172720 - (view) | Author: Chris Jerdonek (chris.jerdonek) *  |
Date: 2012-10-12 07:22 | |
The method signatures for some of the classes documented in library/stdtypes lack the class name. For example, the list, dict, set, and memoryview methods lack the class name. Adding the class name will help to distinguish methods from functions. |
|||
| msg172724 - (view) | Author: Georg Brandl (georg.brandl) * |
Date: 2012-10-12 07:39 | |
This is by design: these method descriptions are indented under their class entries; no need to repeat the class name. |
|||
| msg172727 - (view) | Author: Chris Jerdonek (chris.jerdonek) * |
Date: 2012-10-12 07:46 | |
I think I would be more okay with this if it weren't for the fact that some functions also appear indented under their class entries (making them look like methods). Right now, there's no visual distinction between the functions and the methods. Prefixing the methods with the class name or moving the functions above the class definition would address this. |
|||
| msg172728 - (view) | Author: Georg Brandl (georg.brandl) * |
Date: 2012-10-12 07:47 | |
> I think I would be more okay with this if it weren't for the fact that > some functions also appear indented under their class entries (making > them look like methods). I see, yes. In this case I agree. |
|||
| msg172732 - (view) | Author: Chris Jerdonek (chris.jerdonek) * |
Date: 2012-10-12 08:37 | |
So it looks like the class name gets stripped when rendering if you prefix the method name with the class name and the methods are nested beneath the class. So it seems like the options are to either (1) move the non-methods outside the class (e.g. before the class), or (2) clearly divide the methods and non-methods into two groups (e.g. "These are the operations..." and "These are the methods..."). I lean towards the latter. And it would be a smaller change. |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:57:37 | admin | set | github: 60411 |
| 2012-10-12 09:05:36 | chris.jerdonek | set | title: add class name to method signatures in stdtypes docs -> distinguish methods from non-methods in classes in the stdtypes docs |
| 2012-10-12 08:37:38 | chris.jerdonek | set | messages: + msg172732 |
| 2012-10-12 07:47:25 | georg.brandl | set | messages: + msg172728 |
| 2012-10-12 07:46:07 | chris.jerdonek | set | status: pending -> open messages: + msg172727 |
| 2012-10-12 07:39:51 | georg.brandl | set | status: open -> pending nosy: + georg.brandl messages: + msg172724 resolution: works for me |
| 2012-10-12 07:22:47 | chris.jerdonek | create | |