[issue37557] Example snippets for simpler functions/methods

[Raymond Hettinger]

Raymond Hettinger  added the comment:

We generally only put the examples where they add something substantive.  
Otherwise, it just make the docs verbose and time consuming to read start to 
finish.

Adding an example for str.lower() contributes no additional value.  Most 
published Python books would all avoid the unnecessary here as well.  FWIW, we 
have no evidence that any user has ever found the current form hard to use.

So, let's close this.  If you're looking for places to contribute, please look 
at the open bugs where there are known problems.

--
nosy: +rhettinger
resolution:  -> rejected
stage:  -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

[issue37557] Example snippets for simpler functions/methods

[Kishore]

New submission from Kishore :

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@python
components: Documentation
messages: 347656
nosy: docs@python, kishvanchee
priority: normal
severity: normal
status: open
title: Example snippets for simpler functions/methods
type: enhancement

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com