Skip to content

Use Triple Double-quotes for All Exemplar and Stub Docstrings in Concept Exercises #2537

Closed

Description

@BethanyG

While it doesn't create issues with auto documentation tools, having triple single quotes for docstrings does cause PyLint to complain. It is also strongly discouraged by PEP257.

Since concept exercises are supposed to teach idiomatic and fluent Python, we need to update all of these docstrings ASAP.

There are three tasks involved:

  • Update all exercises/concept/<exercise-name>/.meta/exemplar.py docstrings from single to double triple quotes.
  • Update all exercises/concept/<exercise-name>/<concept-name>.py docstrings from single to double triple quotes.
  • Verify that all exemplar.py files are "clean" (don't toss docstring nags from PyLint).

Activity

  1. added
    x:status/claimedSomeone is working on this issue
    claimed 🐾For new exercises being written by contributors and maintainers.
    on Sep 4, 2021
  2. self-assigned this
    on Sep 4, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

bug 🐛claimed 🐾For new exercises being written by contributors and maintainers.x:size/mediumMedium amount of workx:status/claimedSomeone is working on this issue

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions