Skip to content

CSV documentation doesn't provide example input #151556

@ShaharNaveh

Description

@ShaharNaveh

Documentation

The current CSV documentation (as of 852ec18) doesn't provide an example input for the csv files, making examples like:

>>> with open('eggs.csv', newline='') as csvfile:
... spamreader = csv.reader(csvfile, delimiter=' ', quotechar='|')
... for row in spamreader:
... print(', '.join(row))
Spam, Spam, Spam, Spam, Spam, Baked Beans
Spam, Lovely Spam, Wonderful Spam

ambiguous.

IMO a section in the docs stating something like:

for all code examples bellow we would use an input of:

knight,quest,favorite_color
Sir Lancelot,To seek the Holy Grail,Blue
Sir Robin,To bravely run away,Yellow... no wait Blue! AAARGH

This would make the rest of the examples more clear as to what each flag does

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dir
    No fields configured for issues without a type.

    Projects

    Status
    No status
    Status
    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions