Skip to content

Linting #3

@JosephMontoya-TRI

Description

@JosephMontoya-TRI

"Linting" refers to the practice of revising code to meet standard formatting guidelines for the python programming language. "Linters" are automatic tools that will check code and highlight issues. pycodestyle is my preference currently. There are also tools that will reformat code automatically, black is the most popular of these. I'd recommend running black on the code to fix initial formatting issues, then pycodestyle to detect further issues we can correct.

Note also IDEs like PyCharm can be really useful in correcting these kinds of issues. Using the "Refactor" functionality in those tools, for example, will allow you to rename functions and classes according to style guidelines everywhere they are used in your code automatically.

For this issue, we should revise the code until pycodestyle is satisfied. Let's wait and discuss this a bit, though, so we can ensure we're giving it the right set of parameters for linting your project.

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