docs update

bcdev · Jan 6, 2025 · 5823ca1 · 5823ca1
1 parent eb8b00d
commit 5823ca1
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 6 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -11,7 +11,7 @@
   - CLI exit code 1 with max warnings exceeded 
   - CLI exit code 1 with no files given
   - new CLI options `--plugin`, `--rule`, `--init`
-  - markdown rule reference in docs
+  - markdown rule reference in docs via `mkruleref.py` tool
   - using `files` config option to specify valid filename extensions, see
     [here](https://eslint.org/docs/latest/use/configure/configuration-files#specifying-files-with-arbitrary-extensions)
   - using default filename extensions `["**/*.zarr", "**/*.nc"]`

diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Brockmann Consult Development
+Copyright (c) 2025 Brockmann Consult Development
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/docs/about.md b/docs/about.md
@@ -27,13 +27,18 @@ corresponding issue.
 
 ## Development
 
-To set up development environment, with repository root as current
-working directory:
+To install the XRLint development environment into an existing Python environment
 
 ```bash
 pip install .[dev,doc]
 ```
 
+or create a new environment using
+
+```bash
+mamba env create 
+```
+
 ### Testing and Coverage
 
 XRLint uses [pytest](https://docs.pytest.org/) for unit-level testing 
@@ -45,10 +50,12 @@ pytest --cov=xrlint --cov-report html
 
 ### Code Style
 
-XRLint source code is formatted using the [black](https://black.readthedocs.io/) tool.
+XRLint source code is formatted using the [black](https://black.readthedocs.io/) tool and 
+quality-controlled using [flake8](https://flake8.pycqa.org/).
 
 ```bash
 black .
+flake8 --max-line-length=88 . 
 ```
 
 ### Documentation
@@ -65,6 +72,13 @@ mkdocs serve
 mkdocs gh-deploy
 ```
 
+The rule reference page is generated by a script called `mkruleref.py`.
+After changing or adding a rule, make sure you recreate the page:
+
+```bash
+python -m mkruleref
+```
+
 ## License
 
 XRLint is open source made available under the terms and conditions of the 

diff --git a/docs/todo.md b/docs/todo.md
@@ -7,7 +7,6 @@
 - add `docs`
   - use mkdocstrings ref syntax in docstrings
   - provide configuration examples (use as tests?)
-  - generate markdown rule reference for the docs
 
 ## Desired