Skip to content

Code snippet docstring formatting #291

@deppen8

Description

@deppen8

We have a number of Python code snippets that include a docstring where each new line starts with *. I think "canonical" Python formatting would tell us to use a one-line triple-quoted description.

So this:

"""
 * Python libraries for learning and performing image processing.
 *
"""
import numpy as np
import matplotlib.pyplot as plt
import ipympl
import imageio.v3 as iio
import skimage

Would become this:

"""Python libraries for learning and performing image processing."""

import numpy as np
import matplotlib.pyplot as plt
import ipympl
import imageio.v3 as iio
import skimage

Thoughts?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions