Skip to content

Lint all examples in docstrings #380

Open
Open
Lint all examples in docstrings#380
Labels
part:toolingAffects the development tooling (CI, deployment, dependency management, etc.)type:enhancementNew feature or enhancement visitble to users
Milestone
post-v1.0

Description

@leandro-lucarella-frequenz
leandro-lucarella-frequenz
opened on May 8, 2023

We should run all the same linting tools that we use for the source code on the examples in docstrings:

  • black
  • isort
  • pylint
  • mypy
  • pydocstyle
  • darglint

We should probably support a way to pass extra configuration when applying to examples, as they are not full pieces of code.

Activity

  1. github-project-automation
    added this to Python SDK Roadmapon May 8, 2023
  2. github-project-automation
    moved this to To do in Python SDK Roadmapon May 8, 2023
  3. leandro-lucarella-frequenz
    added this to the v1.0.0 milestone on May 8, 2023
  4. leandro-lucarella-frequenz
    added
    part:toolingAffects the development tooling (CI, deployment, dependency management, etc.)
    type:enhancementNew feature or enhancement visitble to users
    on May 8, 2023

  5. leandro-lucarella-frequenz commented on May 8, 2023

    @leandro-lucarella-frequenz
    leandro-lucarella-frequenz
    on May 8, 2023
    ContributorAuthor

    First step towards this:

  6. llucax commented on Jun 22, 2023

    @llucax
    llucax
    on Jun 22, 2023
    Contributor

    Examples are now being checked with pylint.

  7. llucax
    modified the milestones: v1.0.0, post-v1.0 on Aug 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:toolingAffects the development tooling (CI, deployment, dependency management, etc.)type:enhancementNew feature or enhancement visitble to users

    Type

    No type

    Fields

    Priority

    None yet

    Projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions