More Markdown cleanup

dstebila · dstebila · commit e7198e35c367 · 2026-05-25T21:25:10.000-04:00
Signed-off-by: Douglas Stebila &lt;dstebila@uwaterloo.ca&gt;
diff --git a/docs/algorithms/kem/bike.md b/docs/algorithms/kem/bike.md
@@ -55,4 +55,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/kem/classic_mceliece.md b/docs/algorithms/kem/classic_mceliece.md
@@ -134,4 +134,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/kem/frodokem.md b/docs/algorithms/kem/frodokem.md
@@ -143,4 +143,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/kem/hqc.md b/docs/algorithms/kem/hqc.md
@@ -53,4 +53,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/kem/kyber.md b/docs/algorithms/kem/kyber.md
@@ -72,4 +72,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/kem/ml_kem.md b/docs/algorithms/kem/ml_kem.md
@@ -73,4 +73,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/kem/ntru.md b/docs/algorithms/kem/ntru.md
@@ -88,4 +88,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/kem/ntruprime.md b/docs/algorithms/kem/ntruprime.md
@@ -35,4 +35,4 @@ Are implementations chosen based on runtime CPU feature detection? **No**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/sig/cross.md b/docs/algorithms/sig/cross.md
@@ -208,4 +208,4 @@ Are implementations chosen based on runtime CPU feature detection? **No**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/sig/falcon.md b/docs/algorithms/sig/falcon.md
@@ -75,4 +75,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/sig/mayo.md b/docs/algorithms/sig/mayo.md
@@ -74,4 +74,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/sig/ml_dsa.md b/docs/algorithms/sig/ml_dsa.md
@@ -64,4 +64,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/sig/mqom.md b/docs/algorithms/sig/mqom.md
@@ -162,4 +162,4 @@ Are implementations chosen based on runtime CPU feature detection? **No**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/sig/slh_dsa.md b/docs/algorithms/sig/slh_dsa.md
@@ -1432,4 +1432,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/sig/snova.md b/docs/algorithms/sig/snova.md
@@ -162,4 +162,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/docs/algorithms/sig/uov.md b/docs/algorithms/sig/uov.md
@@ -162,4 +162,4 @@ Are implementations chosen based on runtime CPU feature detection? **Yes**.
 
 ## Explanation of Terms
 
-- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
+- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.
diff --git a/scripts/update_docs_from_yaml.py b/scripts/update_docs_from_yaml.py
@@ -172,7 +172,7 @@ def do_it(liboqs_root):
                     out_md.write('\n ‡For an explanation of what this denotes, consult the [Explanation of Terms](#explanation-of-terms) section at the end of this file.\n')
 
             out_md.write('\n## Explanation of Terms\n\n')
-            out_md.write('- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.')
+            out_md.write('- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.\n')
 
     ##############################################
     # Update the signature markdown documentation.
@@ -311,7 +311,7 @@ def do_it(liboqs_root):
                     out_md.write('\n ‡For an explanation of what this denotes, consult the [Explanation of Terms](#explanation-of-terms) section at the end of this file.\n')
 
             out_md.write('\n## Explanation of Terms\n\n')
-            out_md.write('- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.')
+            out_md.write('- **Large Stack Usage**: Implementations identified as having such may cause failures when running in threads or in constrained environments.\n')
 
 
     ##############################################
diff --git a/zephyr/README.md b/zephyr/README.md
@@ -53,4 +53,4 @@ Other architectures supported by Zephyr are not supported with this port, as lib
 
 ### Samples
 
-Two sample applications are provided, demonstrating the usage of the library from within Zephyr. See [`samples/KEMs`](https://github.com/open-quantum-safe/liboqs/tree/main/zephyr/samples/Signatures) and [`samples/Signatures`](https://github.com/open-quantum-safe/liboqs/tree/main/zephyr/samples/KEMs).
+Two sample applications are provided, demonstrating the usage of the library from within Zephyr. See [`samples/KEMs`](https://github.com/open-quantum-safe/liboqs/tree/main/zephyr/samples/Signatures) and [`samples/Signatures`](https://github.com/open-quantum-safe/liboqs/tree/main/zephyr/samples/KEMs).

Original file line number	Diff line number	Diff line change
`@@ -55,4 +55,4 @@ Are implementations chosen based on runtime CPU feature detection? Yes.`
`55`	`55`
`56`	`56`	`## Explanation of Terms`
`57`	`57`
`58`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`58`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
Original file line number	Diff line number	Diff line change
`@@ -134,4 +134,4 @@ Are implementations chosen based on runtime CPU feature detection? Yes.`
`134`	`134`
`135`	`135`	`## Explanation of Terms`
`136`	`136`
`137`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`137`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
Original file line number	Diff line number	Diff line change
`@@ -143,4 +143,4 @@ Are implementations chosen based on runtime CPU feature detection? Yes.`
`143`	`143`
`144`	`144`	`## Explanation of Terms`
`145`	`145`
`146`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`146`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
Original file line number	Diff line number	Diff line change
`@@ -53,4 +53,4 @@ Are implementations chosen based on runtime CPU feature detection? Yes.`
`53`	`53`
`54`	`54`	`## Explanation of Terms`
`55`	`55`
`56`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`56`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
Original file line number	Diff line number	Diff line change
`@@ -72,4 +72,4 @@ Are implementations chosen based on runtime CPU feature detection? Yes.`
`72`	`72`
`73`	`73`	`## Explanation of Terms`
`74`	`74`
`75`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`75`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
Original file line number	Diff line number	Diff line change
`@@ -73,4 +73,4 @@ Are implementations chosen based on runtime CPU feature detection? Yes.`
`73`	`73`
`74`	`74`	`## Explanation of Terms`
`75`	`75`
`76`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`76`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
Original file line number	Diff line number	Diff line change
`@@ -88,4 +88,4 @@ Are implementations chosen based on runtime CPU feature detection? Yes.`
`88`	`88`
`89`	`89`	`## Explanation of Terms`
`90`	`90`
`91`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`91`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
Original file line number	Diff line number	Diff line change
`@@ -35,4 +35,4 @@ Are implementations chosen based on runtime CPU feature detection? No.`
`35`	`35`
`36`	`36`	`## Explanation of Terms`
`37`	`37`
`38`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`38`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
Original file line number	Diff line number	Diff line change
`@@ -208,4 +208,4 @@ Are implementations chosen based on runtime CPU feature detection? No.`
`208`	`208`
`209`	`209`	`## Explanation of Terms`
`210`	`210`
`211`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`211`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
Original file line number	Diff line number	Diff line change
`@@ -75,4 +75,4 @@ Are implementations chosen based on runtime CPU feature detection? Yes.`
`75`	`75`
`76`	`76`	`## Explanation of Terms`
`77`	`77`
`78`		`-- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`
	`78`	`+- Large Stack Usage: Implementations identified as having such may cause failures when running in threads or in constrained environments.`