From: whitequark <cz@m-labs.hk>
Date: Sat, 15 Dec 2018 12:07:56 +0000 (+0000)
Subject: doc: fix some Markdown awkwardness.
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=f85bb4439568236b5a315aa4a2fde33212cc1449;p=nmigen.git

doc: fix some Markdown awkwardness.
---

diff --git a/doc/COMPAT_SUMMARY.md b/doc/COMPAT_SUMMARY.md
index 0a7dae4..658b762 100644
--- a/doc/COMPAT_SUMMARY.md
+++ b/doc/COMPAT_SUMMARY.md
@@ -34,7 +34,7 @@ Compatibility summary
       - (+) `value_bits_sign` → `Value.shape`
     - (−) `conv_output` ?
     - (+) `decorators` ⇒ `.fhdl.xfrm`
-      Note: `transform_*` methods not considered part of public API.
+      <br>Note: `transform_*` methods not considered part of public API.
       - (⊙) `ModuleTransformer` **brk**
       - (⊙) `ControlInserter` **brk**
       - (+) `CEInserter` id, `clock_domains=`→`controls=`
@@ -60,7 +60,7 @@ Compatibility summary
     - (−) `structure` → `.fhdl.ast`
       - (+) `DUID` id
       - (+) `_Value` → `Value`
-        Note: values no longer valid as keys in `dict` and `set`; use `ValueDict` and `ValueSet` instead.
+        <br>Note: values no longer valid as keys in `dict` and `set`; use `ValueDict` and `ValueSet` instead.
       - (+) `wrap` → `Value.wrap`
       - (+) `_Operator` → `Operator`
       - (+) `Mux` → `Mux`
@@ -172,9 +172,9 @@ Compatibility summary
     - (−) `sort` ?
       - (−) `BitonicSort` ?
   - (-) `sim` **obs** → `.back.pysim`
+    <br>Note: only items directly under `nmigen.compat.sim`, not submodules, are provided.
     - (⊙) `core` **brk**
     - (⊙) `vcd` **brk** → `vcd`
-    Note: only items directly under `nmigen.compat.sim`, not submodules, are provided.
     - (⊙) `Simulator` **brk**
     - (+) `run_simulation` **obs** → `.back.pysim.Simulator`
     - (−) `passive` **obs** → `.fhdl.ast.Passive`