diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 83600f72..bf45107f 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,4 +1,4 @@ -name: Code Linting 🔎⚡ +name: Linting 📑🔎⚡ on: push: @@ -6,14 +6,12 @@ on: workflow_dispatch: jobs: - - lint: + ruff: name: Ruff ⚡🕵 runs-on: ubuntu-latest steps: - - name: 📥 Checkout repo uses: actions/checkout@v4 @@ -21,3 +19,18 @@ jobs: uses: astral-sh/ruff-action@v3 with: args: check + + markdownlint: + name: Markdownlint 📑🕵 + + runs-on: ubuntu-latest + steps: + - name: 📥 Checkout repo + uses: actions/checkout@v4 + + - name: Run markdownlint-cli2-action 📑 + uses: DavidAnson/markdownlint-cli2-action@v22 + with: + globs: | + *.md + !test/*.md diff --git a/.vscode/settings.json b/.vscode/settings.json index 31b34f9e..b34020b9 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -15,31 +15,56 @@ "bdvp", "bigstitcher", "biop", + "clij", + "Dscijava", + "flatfield", + "Fluo", + "IJPB", "imageplus", + "imarisconvert", "imglib", + "imgplus", "interestpoint", "intermodes", "javax", + "keyvalue", "Kheops", + "labelimage", + "listdir", "micrometa", + "Morpholib", "multiresolution", + "olefile", + "omerotools", + "ordereddict", "otsu", "pathtools", + "phmax", "Prefs", + "processingoptions", "PTBIOP", "PYENV", "pylint", "ransac", "renyi", "repartitions", + "resultstable", "RETVAL", + "roimanager", + "rois", + "rollingball", "scijava", "shanbhag", "sjlogging", + "smtpserver", "spimdata", + "stardist", + "stdv", "strtools", "subfolders", "subsampling", + "TESTDATA", + "thresholding", "trackmate", "virtualenv", "virtualfish" diff --git a/DESC.md b/DESC.md index edeefe8f..b377c969 100644 --- a/DESC.md +++ b/DESC.md @@ -1,2 +1,4 @@ + + :snake::coffee::nut_and_bolt::wrench: A collection of commonly used Python helper functions. diff --git a/TESTING.md b/TESTING.md index c58e3c73..35954ed2 100644 --- a/TESTING.md +++ b/TESTING.md @@ -6,9 +6,9 @@ Those parts of the package that do not interact / depend on ImageJ objects can be tested via [`pytest`][pytest] up to a certain level, some (most?) of them should even work in a Python 3 environment. -To perform those tests, the packges otherwise provided by ImageJ need to be -mocked using the `imcf-fiji-mocks` package. For seting up a *venv* use the steps -described here: +To perform those tests, the packages otherwise provided by ImageJ need to be +mocked using the `imcf-fiji-mocks` package. For setting up a *venv* use the +steps described here: ```bash # check if we're "inside" the repo already, otherwise clone it here: