diff options
| author | Jack Koenig | 2021-10-05 02:39:21 +0200 |
|---|---|---|
| committer | GitHub | 2021-10-05 00:39:21 +0000 |
| commit | 98c5ef031893aacc7cd6a17e8a715ab3a83f05db (patch) | |
| tree | 12c69c1e9d9116d0791ca97f6b9bef110c8b2818 | |
| parent | df76831ce1867ed5a9d25255e81c9437961eb284 (diff) | |
Remove workaround for fixed issue in mdoc crash blocks (#2147)
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
| -rw-r--r-- | docs/src/explanations/dataview.md | 4 |
1 files changed, 0 insertions, 4 deletions
diff --git a/docs/src/explanations/dataview.md b/docs/src/explanations/dataview.md index 2f229bfc..b1f48f20 100644 --- a/docs/src/explanations/dataview.md +++ b/docs/src/explanations/dataview.md @@ -285,7 +285,6 @@ class BundleB extends Bundle { ``` ```scala mdoc:crash -{ // Using an extra scope here to avoid a bug in mdoc (documentation generation) // We forgot BundleA.foo in the mapping! implicit val myView = DataView[BundleA, BundleB](_ => new BundleB, _.bar -> _.fizz) class BadMapping extends Module { @@ -295,7 +294,6 @@ class BadMapping extends Module { } // We must run Chisel to see the error emitVerilog(new BadMapping) -} ``` As that error suggests, if we *want* the view to be non-total, we can use a `PartialDataView`: @@ -321,7 +319,6 @@ This has the consequence that `PartialDataViews` are **not** invertible in the s For example: ```scala mdoc:crash -{ // Using an extra scope here to avoid a bug in mdoc (documentation generation) implicit val myView2 = myView.invert(_ => new BundleA) class PartialDataViewModule2 extends Module { val in = IO(Input(new BundleA)) @@ -331,7 +328,6 @@ class PartialDataViewModule2 extends Module { } // We must run Chisel to see the error emitVerilog(new PartialDataViewModule2) -} ``` As noted, the mapping must **always** be total for the `View`. |
