diff options
| author | Adam Izraelevitz | 2020-10-26 16:48:44 -0700 |
|---|---|---|
| committer | GitHub | 2020-10-26 23:48:44 +0000 |
| commit | 58fa3c1118d9e892895970d48e2ba8a3c182bb81 (patch) | |
| tree | a672be8750c8c8dd2bb1645f88b4ce1bbbb37993 /docs/src/cookbooks | |
| parent | 1b6bd89dfafc774af1c926a982418294091f6346 (diff) | |
Fix crosslinks in mdoc. Can't use md suffix (#1640)
* Fix crosslinks in mdoc. Can't use md suffix
* Removed all .md crossrefs
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Diffstat (limited to 'docs/src/cookbooks')
| -rw-r--r-- | docs/src/cookbooks/naming.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/src/cookbooks/naming.md b/docs/src/cookbooks/naming.md index 4d87ece7..150f0639 100644 --- a/docs/src/cookbooks/naming.md +++ b/docs/src/cookbooks/naming.md @@ -31,12 +31,12 @@ renaming these signals with more context-dependent names, but it is a work in pr This is the infamous `Queue` instability problem. In general, these cases are best solved at the source - the module itself! If you overwrite `desiredName` to include parameter information (see the -[explanation](../explanations/naming.md#set-a-module-name) for more info), then this can avoid this problem permanantly. +[explanation](../explanations/naming#set-a-module-name) for more info), then this can avoid this problem permanantly. We've done this with some Chisel utilities with great results! ### I want to add some hardware or assertions, but each time I do all the signal names get bumped! -This is the classic "ECO" problem, and we provide descriptions in [explanation](../explanations/naming.md). In short, +This is the classic "ECO" problem, and we provide descriptions in [explanation](../explanations/naming). In short, we recommend wrapping all additional logic in a prefix scope, which enables a unique namespace. This should prevent name collisions, which are what triggers all those annoying signal name bumps! |
