Add comment explaining --check in simple_example.

realazthat · Jul 12, 2024 · 4b7f3ac · 4b7f3ac
1 parent 2534c4d
commit 4b7f3ac
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 0 deletions.
diff --git a/.github/README.remotified.md b/.github/README.remotified.md
@@ -253,6 +253,7 @@ docker run --rm --tty \
   -o "mdreftidy/examples/SIMPLE.tidied.md" \
   --move-to-bottom --remove-unused --sort-ref-blocks --renumber
 
+# Now --check to verify:
 docker run --rm --tty \
   -v "${PWD}:/data" \
   ghcr.io/realazthat/mdreftidy:v0.5.0 \
@@ -285,6 +286,7 @@ docker run --rm --tty \
   -o "mdreftidy/examples/SIMPLE.tidied.md" \
   --move-to-bottom --remove-unused --sort-ref-blocks --renumber
 
+# Now --check to verify:
 docker run --rm --tty \
   -v "${PWD}:/data" \
   my-mdreftidy-image \

diff --git a/README.md b/README.md
@@ -253,6 +253,7 @@ docker run --rm --tty \
   -o "mdreftidy/examples/SIMPLE.tidied.md" \
   --move-to-bottom --remove-unused --sort-ref-blocks --renumber
 
+# Now --check to verify:
 docker run --rm --tty \
   -v "${PWD}:/data" \
   ghcr.io/realazthat/mdreftidy:v0.5.0 \
@@ -285,6 +286,7 @@ docker run --rm --tty \
   -o "mdreftidy/examples/SIMPLE.tidied.md" \
   --move-to-bottom --remove-unused --sort-ref-blocks --renumber
 
+# Now --check to verify:
 docker run --rm --tty \
   -v "${PWD}:/data" \
   my-mdreftidy-image \

diff --git a/mdreftidy/examples/local-docker_example.sh b/mdreftidy/examples/local-docker_example.sh
@@ -33,6 +33,7 @@ docker run --rm --tty \
   -o "mdreftidy/examples/SIMPLE.tidied.md" \
   --move-to-bottom --remove-unused --sort-ref-blocks --renumber
 
+# Now --check to verify:
 docker run --rm --tty \
   -v "${PWD}:/data" \
   my-mdreftidy-image \

diff --git a/mdreftidy/examples/remote-docker_example-noautorun.sh b/mdreftidy/examples/remote-docker_example-noautorun.sh
@@ -32,6 +32,7 @@ docker run --rm --tty \
   -o "mdreftidy/examples/SIMPLE.tidied.md" \
   --move-to-bottom --remove-unused --sort-ref-blocks --renumber
 
+# Now --check to verify:
 docker run --rm --tty \
   -v "${PWD}:/data" \
   ghcr.io/realazthat/mdreftidy:v0.5.0 \

diff --git a/mdreftidy/examples/simple_example.sh b/mdreftidy/examples/simple_example.sh
@@ -17,6 +17,7 @@ python -m mdreftidy.cli \
   -o "mdreftidy/examples/SIMPLE.tidied.md" \
   --move-to-bottom --remove-unused --sort-ref-blocks --renumber
 
+# Now --check to verify:
 python -m mdreftidy.cli \
   --check \
   "mdreftidy/examples/SIMPLE.tidied.md" \

diff --git a/mdreftidy/examples/simple_example.sh.jinja2 b/mdreftidy/examples/simple_example.sh.jinja2
@@ -57,6 +57,7 @@ cat "mdreftidy/examples/SIMPLE.md"
   -o "mdreftidy/examples/SIMPLE.tidied.md" \
   --move-to-bottom --remove-unused --sort-ref-blocks --renumber
 
+# Now --check to verify:
 {{mdreftidy_cmd|safe}} \
   --check \
   "mdreftidy/examples/SIMPLE.tidied.md" \