docs(prp): fix removal version of fraction option (#2126)

The PRP DFN described the fraction option has having been removed in 6.5.1, which never materialized. It was removed in 6.6.0 instead.

Fix an mf6io document issue where deprecated/removed options remained in keystring descriptions.

Add cffconvert to the project dependencies, add a corresponding pixi task, and use it in CI. There is some issue with the check cff action.

Author: wpbonelli

.codespellrc

@@ -1,3 +1,3 @@
 [codespell]
-skip = *.pdf,*.grb,*.bib,*.bst,*.log,./builddir,./src/Utilities/Libraries,./utils/mf5to6,./doc/ReleaseNotes/previous
+skip = *.pdf,*.grb,*.bib,*.bst,*.log,./builddir,./src/Utilities/Libraries,./utils/mf5to6,./doc/ReleaseNotes/previous,pixi.*
 ignore-words = .codespell.ignore

.github/workflows/ci.yml

@@ -66,7 +66,7 @@ jobs:
         run: pixi run check-python-format
 
       - name: Check CITATION.cff
-        uses: dieghernan/cff-validator@v3
+        run: pixi run check-citations
 
   build:
     name: Build

doc/mf6io/mf6ivar/dfn/prt-prp.dfn

@@ -400,6 +400,6 @@ tagged true
 in_record true
 reader urword
 optional true
-removed 6.5.1
+removed 6.6.0
 longname
 description release particles after the specified fraction of the time step has elapsed. If FRACTION is not set, particles are released at the start of the specified time step(s). FRACTION must be a single value when used with ALL, FIRST, or FREQUENCY. When used with STEPS, FRACTION may be a single value or an array of the same length as STEPS. If a single FRACTION value is provided with STEPS, the fraction applies to all steps. NOTE: The FRACTION option has been removed. For fine control over release timing, specify times explicitly using the RELEASETIMES block.

doc/mf6io/mf6ivar/mf6ivar.py

@@ -413,6 +413,11 @@ def write_desc(vardict, block, blk_var_list, varexcludeprefix=None):
                     # s += '\\begin{verbatim}\n'
                     s += "\\begin{lstlisting}[style=blockdefinition]\n"
                     for vn in t.strip().split()[1:]:
+                        if (
+                            "removed" in vardict[(vn, block)]
+                            or "deprecated" in vardict[(vn, block)]
+                        ):
+                            continue
                         blockentry = block_entry(vn, block, vardict, "")
                         s += f"{blockentry}\n"
                     # s += '\\end{verbatim}\n\n'

environment.yml

@@ -7,6 +7,7 @@ channels:
 dependencies:
   - python>=3.9
   - appdirs
+  - cffconvert
   - codespell
   - filelock
   - flaky

pixi.lock

@@ -6,6 +6,7 @@ version = "6.7.0.dev0"
 
 [dependencies]
 appdirs = "*"
+cffconvert = "*"
 codespell = "*"
 filelock = "*"
 flaky = "*"
@@ -109,6 +110,7 @@ build-dist = { cmd = "python build_dist.py", cwd = "distribution" }
 test-dist-scripts = { cmd = "pytest -v --durations 0", cwd = "distribution" }
 update-version = { cmd = "python update_version.py", cwd = "distribution" }
 deprecations = { cmd = "python deprecations.py", cwd = "doc/mf6io/mf6ivar" }
+check-citations = "cffconvert --validate -i CITATION.cff"
 
 [feature.rtd.tasks]
 sphinx = { cmd = "make html", cwd = ".build_rtd_docs" }