[issue26451] CSV documentation doesn't open with an example

[Irit Katriel]

Change by Irit Katriel :


--
resolution:  -> out of date
stage:  -> resolved
status: pending -> closed

___
Python tracker 

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

[issue26451] CSV documentation doesn't open with an example

[Irit Katriel]

Irit Katriel  added the comment:

The example in the patch is very similar to the example that's in the doc under 
"A short usage example::", which is not that far below the beginning of the doc.

--
nosy: +iritkatriel
status: open -> pending

___
Python tracker 

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

[issue26451] CSV documentation doesn't open with an example

[Alex LordThorsen]

New submission from Alex LordThorsen:

Had a friend get stuck on the CSV documentation. They didn't know what a CSV 
was (to start with) and couldn't find an example that made sense to them.  they 
went to other sources to figure out how to read CSV files in the end.

I made this patch in the hope that starting out with a very minimal example 
file format followed by an example python read will make landing on the CSV 
docs easier to follow for new programmers.

--
assignee: docs@python
components: Documentation
files: csv_documentation.patch
keywords: patch
messages: 260960
nosy: Alex.LordThorsen, docs@python
priority: normal
severity: normal
status: open
title: CSV documentation doesn't open with an example
versions: Python 3.6
Added file: http://bugs.python.org/file42040/csv_documentation.patch

___
Python tracker 

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