Skip to content

Commit 78bbbc0

Browse files
committed
[Doc]: fix a syntax bug in "include_dir" docs
Signed-off-by: Seyed Alireza Damghani <[email protected]>
1 parent aed1e6f commit 78bbbc0

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

doc/src/vtr/tasks.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,15 @@ Optional Fields
144144

145145
Absolute path or relative to ``$VTR_ROOT/vtr_flow/``.
146146

147-
Note: Multiple _includes_dir_ are NOT allowed in a task config file.
147+
Note: Multiple `includes_dir` are NOT allowed in a task config file.
148148

149-
* **include_list_add**: A path to an _include_ file, which is relative to _includes_dir_
149+
* **include_list_add**: A path to an `include` file, which is relative to `includes_dir`
150150

151-
Multiple _include_list_add_ can be provided.
151+
Multiple `include_list_add` can be provided.
152152

153-
_include_ files could act as the top module complementary, like definitions, macros or sub-modules.
153+
`include` files could act as the top module complementary, like definitions, macros or sub-modules.
154154

155-
Note: _include_ files will be shared among all benchmark circuits in the task config file.
155+
Note: `include` files will be shared among all benchmark circuits in the task config file.
156156

157157
* **pass_requirements_file**: :ref:`vtr_pass_requirements` file.
158158

0 commit comments

Comments
 (0)