Skip to content

Add custom pygrep QAQC tooling #2717

Description

@VeckoTheGecko

Look into custom pygrep linting.

We can add custom QAQC pre-commit rules to Parcels to enforce internal conventions. Ones I have in mind:

instead of

from parcels.convert import nemo_to_sgrid

nemo_to_sgrid(...)

use

import parcels

parcels.convert.nemo_to_sgrid(...)

# or
from parcels import convert
convert.nemo_to_sgrid(...)

instead of

from parcels._typing import Mesh #etc.

Mesh

use

import parcels._typing as ptyping # enforce the ptyping alias

ptyping.Mesh

Metadata

Metadata

Assignees

No one assigned

    Labels

    metaIssues to do with organisation, dev setups, branding, or things non-code related related.

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    Status
    Backlog

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions