From 1cf1c5f02d17cb779cbce0741592c518f0a40c8b Mon Sep 17 00:00:00 2001 From: Krystine Sherwin <93062060+KrystalDelusion@users.noreply.github.com> Date: Mon, 21 Sep 2026 11:25:11 +1200 Subject: [PATCH] contributing.rst: Fixing up formatting --- .../extending_yosys/contributing.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/source/yosys_internals/extending_yosys/contributing.rst b/docs/source/yosys_internals/extending_yosys/contributing.rst index efb08e203..71763f132 100644 --- a/docs/source/yosys_internals/extending_yosys/contributing.rst +++ b/docs/source/yosys_internals/extending_yosys/contributing.rst @@ -25,10 +25,10 @@ briefly describe the issue, for example: techmap of wide mux with undefined inputs raises error during synth_xilinx - + tells us what's happening ("raises error") - + gives the command affected (`techmap`) - + an overview of the input design ("wide mux with undefined inputs") - + and some context where it was found ("during `synth_xilinx`") ++ tells us what's happening ("raises error") ++ gives the command affected (`techmap`) ++ an overview of the input design ("wide mux with undefined inputs") ++ and some context where it was found ("during `synth_xilinx`") Reproduction Steps @@ -67,10 +67,8 @@ code-formatting (starting and ending with single backquotes). `yosys -p ': minimum sequence of commands;' min.v` Alternatively, you can provide a single code-block which includes the minimized -design as a "here document" followed by the sequence of commands which -reproduce the error - - + see :doc:`/using_yosys/more_scripting/load_design` for more on heredocs. +design as a "here document" followed by the sequence of commands which reproduce +the error: .. code-block:: markdown @@ -81,6 +79,8 @@ reproduce the error # minimum sequence of commands ``` +.. seealso:: See :doc:`/using_yosys/more_scripting/load_design` for more on heredocs. + Don't forget to mention: - any important environment variables or command line options