From: Catherine Date: Thu, 16 Dec 2021 15:44:08 +0000 (+0000) Subject: docs: don't call Python modules "packages". X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=33fd0ead0a8f4c1ae8e621ffecff4dc49905023d;p=nmigen.git docs: don't call Python modules "packages". --- diff --git a/docs/platform/intel.rst b/docs/platform/intel.rst index 6642dff..05433e8 100644 --- a/docs/platform/intel.rst +++ b/docs/platform/intel.rst @@ -3,8 +3,8 @@ Intel .. py:module:: nmigen.vendor.intel -The :mod:`nmigen.vendor.intel` package provides a base platform to support Intel toolchains. +The :mod:`nmigen.vendor.intel` module provides a base platform to support Intel toolchains. The Quartus and Mistral toolchains are supported. -.. autoclass:: IntelPlatform \ No newline at end of file +.. autoclass:: IntelPlatform diff --git a/docs/platform/lattice-ecp5.rst b/docs/platform/lattice-ecp5.rst index 5a6db08..0e1eba6 100644 --- a/docs/platform/lattice-ecp5.rst +++ b/docs/platform/lattice-ecp5.rst @@ -3,8 +3,8 @@ Lattice ECP5 .. py:module:: nmigen.vendor.lattice_ecp5 -The :mod:`nmigen.vendor.lattice_ecp5` package provides a base platform to support Lattice ECP5 devices. +The :mod:`nmigen.vendor.lattice_ecp5` module provides a base platform to support Lattice ECP5 devices. The Trellis and Diamond toolchains are supported. -.. autoclass:: LatticeECP5Platform \ No newline at end of file +.. autoclass:: LatticeECP5Platform diff --git a/docs/platform/lattice-ice40.rst b/docs/platform/lattice-ice40.rst index e1e3887..6069fa7 100644 --- a/docs/platform/lattice-ice40.rst +++ b/docs/platform/lattice-ice40.rst @@ -3,8 +3,8 @@ Lattice iCE40 .. py:module:: nmigen.vendor.lattice_ice40 -The :mod:`nmigen.vendor.lattice_ice40` package provides a base platform to support Lattice iCE40 devices. +The :mod:`nmigen.vendor.lattice_ice40` module provides a base platform to support Lattice iCE40 devices. The IceStorm and iCECube2 toolchains are supported. -.. autoclass:: LatticeICE40Platform \ No newline at end of file +.. autoclass:: LatticeICE40Platform diff --git a/docs/platform/lattice-machxo-2-3l.rst b/docs/platform/lattice-machxo-2-3l.rst index df262e7..357f721 100644 --- a/docs/platform/lattice-machxo-2-3l.rst +++ b/docs/platform/lattice-machxo-2-3l.rst @@ -3,7 +3,7 @@ Lattice MachXO2 and MachXO3L .. py:module:: nmigen.vendor.lattice_machxo_2_3l -The :mod:`nmigen.vendor.lattice_machxo_2_3l` package provides a base platform to support Lattice +The :mod:`nmigen.vendor.lattice_machxo_2_3l` module provides a base platform to support Lattice MachXO2 and MachXO3L devices. The Diamond toolchain is supported. @@ -16,4 +16,4 @@ The Diamond toolchain is supported. .. note:: Both of the above are aliases for the actual platform below, however only the aliased definitions are actually exported from the module for use. -.. autoclass:: LatticeMachXO2Or3LPlatform \ No newline at end of file +.. autoclass:: LatticeMachXO2Or3LPlatform diff --git a/docs/platform/quicklogic.rst b/docs/platform/quicklogic.rst index 7abd965..780a390 100644 --- a/docs/platform/quicklogic.rst +++ b/docs/platform/quicklogic.rst @@ -3,8 +3,8 @@ Quicklogic .. py:module:: nmigen.vendor.quicklogic -The :mod:`nmigen.vendor.quicklogic` package provides a base platform to support Quicklogic toolchains. +The :mod:`nmigen.vendor.quicklogic` module provides a base platform to support Quicklogic toolchains. The Symbiflow toolchain is supported. -.. autoclass:: QuicklogicPlatform \ No newline at end of file +.. autoclass:: QuicklogicPlatform diff --git a/docs/platform/xilinx.rst b/docs/platform/xilinx.rst index 5630382..8edb3fd 100644 --- a/docs/platform/xilinx.rst +++ b/docs/platform/xilinx.rst @@ -3,8 +3,8 @@ Xilinx .. py:module:: nmigen.vendor.xilinx -The :mod:`nmigen.vendor.xilinx` package provides a base platform to support Xilinx toolchains. +The :mod:`nmigen.vendor.xilinx` module provides a base platform to support Xilinx toolchains. The ISE, Vivado, and Symbiflow toolchains are supported. -.. autoclass:: XilinxPlatform \ No newline at end of file +.. autoclass:: XilinxPlatform diff --git a/docs/stdlib/cdc.rst b/docs/stdlib/cdc.rst index 18b9e6b..c89917b 100644 --- a/docs/stdlib/cdc.rst +++ b/docs/stdlib/cdc.rst @@ -3,7 +3,7 @@ Clock domain crossing .. py:module:: nmigen.lib.cdc -The :mod:`nmigen.lib.cdc` package provides modules for transferring data between clock domains. +The :mod:`nmigen.lib.cdc` module provides building blocks for transferring data between clock domains. .. autoclass:: FFSynchronizer() diff --git a/docs/stdlib/coding.rst b/docs/stdlib/coding.rst index a79cd1f..79af3b1 100644 --- a/docs/stdlib/coding.rst +++ b/docs/stdlib/coding.rst @@ -3,7 +3,7 @@ Code conversion .. py:module:: nmigen.lib.coding -The :mod:`nmigen.lib.coding` package provides modules for conversion between different encodings of binary numbers. +The :mod:`nmigen.lib.coding` module provides building blocks for conversion between different encodings of binary numbers. One-hot coding diff --git a/docs/stdlib/fifo.rst b/docs/stdlib/fifo.rst index f7825e1..bb08ee9 100644 --- a/docs/stdlib/fifo.rst +++ b/docs/stdlib/fifo.rst @@ -3,7 +3,7 @@ First-in first-out queues .. py:module:: nmigen.lib.fifo -The ``nmigen.lib.fifo`` package provides modules for first-in, first-out queues. +The ``nmigen.lib.fifo`` module provides building blocks for first-in, first-out queues. .. autoclass:: FIFOInterface