[docs] [issue37557] Example snippets for simpler functions/methods

Kishore report at bugs.python.org
Thu Jul 11 02:49:39 EDT 2019

New submission from Kishore <kishore.vancheeshwaran at gmail.com>:

Is there a reason why many (not all) of the simpler methods lack example snippets?

Snippets which are present:

1. https://docs.python.org/3/library/stdtypes.html#str.rstrip
2. https://docs.python.org/3/library/stdtypes.html#str.strip

Snippets which are not present:

1. https://docs.python.org/3/library/stdtypes.html#str.lower
2. https://docs.python.org/3/library/stdtypes.html#str.upper
3. https://docs.python.org/3/library/stdtypes.html#str.isupper

Is there any recommendation against adding concise example snippets for all methods?

I am of the opinion that short examples are more easier to read and visually skim through, than reading the description. I was hoping I could add example snippets to the simpler methods if anyone does not have any objection towards it.

assignee: docs at python
components: Documentation
messages: 347656
nosy: docs at python, kishvanchee
priority: normal
severity: normal
status: open
title: Example snippets for simpler functions/methods
type: enhancement

Python tracker <report at bugs.python.org>

More information about the docs mailing list