Skip to content

Commit 919cc39

Browse files
committed
fixup docs
1 parent d57b6f0 commit 919cc39

File tree

3 files changed

+27
-2
lines changed

3 files changed

+27
-2
lines changed

docs/best-practices.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,8 @@ With default assignments:
103103
104104
.. tip::
105105

106-
Use default assignments in the most local lexical scope possible.
106+
Use default assignments in the most local lexical scope that is appropriate.
107107
This improves readability, and prevents the assignment from affecting
108108
something you didn't intend.
109+
110+
Avoid using default assignments in the root namespace.

docs/for-devs/importer-plugin.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ Plugin Discovery
6262
There are two ways PeakRDL can discover your plugin.
6363

6464
Via Entry Point
65-
---------------
65+
^^^^^^^^^^^^^^^
6666

6767
The PeakRDL command line tool automatically discovers importers by scanning the
6868
entry points that installed packages advertise.

docs/style-guide.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,29 @@ Parameters and Verilog-style macros are uppercase
208208
-------------------------------------------------
209209
Constants should be in ALL_CAPS
210210

211+
|:thumbsup:|
212+
213+
.. code:: systemrdl
214+
215+
field my_field #(
216+
longint unsigned MY_PARAM = 1,
217+
longint unsigned OTHER_PARAM = 2
218+
){
219+
// ...
220+
};
221+
222+
223+
|:thumbsdown:|
224+
225+
.. code:: systemrdl
226+
227+
field my_field #(
228+
longint unsigned my_param = 1,
229+
longint unsigned other_param = 2
230+
){
231+
// ...
232+
};
233+
211234
212235
Long descriptions
213236
-----------------

0 commit comments

Comments
 (0)