From 0ede42417ff4bc5f559e3beacc95968310c9b084 Mon Sep 17 00:00:00 2001 From: Jan Decaluwe Date: Tue, 7 Jul 2015 10:06:31 +0200 Subject: [PATCH] Doc update for ConcatSignal --- doc/source/index.rst | 1 + doc/source/manual/reference.rst | 20 +++++++++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index b330da01..556edd3a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -29,6 +29,7 @@ Old Whatsnew documents whatsnew/0.8 whatsnew/0.7 whatsnew/0.6 + whatsnew/0.5 whatsnew/0.4 whatsnew/0.3 diff --git a/doc/source/manual/reference.rst b/doc/source/manual/reference.rst index e34b61d1..f15a6736 100644 --- a/doc/source/manual/reference.rst +++ b/doc/source/manual/reference.rst @@ -212,7 +212,7 @@ Shadow signals .. class:: _SliceSignal(sig, left[, right=None]) This class implements read-only structural slicing and indexing. It creates a new - signal that shadows the slice or index of the parent signal *sig*. If the + shadow signal of the slice or index of the parent signal *sig*. If the *right* parameter is omitted, you get indexing instead of slicing. Parameters *left* and *right* have the usual meaning for slice indices: in particular, *left* is non-inclusive but *right* @@ -229,11 +229,15 @@ Shadow signals .. class:: ConcatSignal(*args) - This class creates a new signal that shadows the concatenation - of its parent signal values. You can pass an arbitrary number - of signals to the constructor. The signal arguments should be bit-oriented - with a defined number of bits. + This class creates a new shadow signal of the concatenation of its arguments. + You can pass an arbitrary number of arguments to the constructor. The + arguments should be bit-oriented with a defined number of bits. The following + argument types are supported: :class:`intbv` objects with a defined bit width, + :class:`bool` objects, signals of the previous objects, and bit strings. + + The new signal follows the value changes of the signal arguments. The non-signal + arguments are used to define constant values in the concatenation. .. class:: TristateSignal(val) @@ -601,8 +605,10 @@ useful for hardware description. The following argument types are supported: :class:`intbv` objects with a defined bit width, :class:`bool` objects, signals of the previous objects, and - bit strings. All these objects have a defined bit width. The first argument - *base* is special as it doesn't need to have a defined bit width. In addition to + bit strings. All these objects have a defined bit width. + + The first argument *base* is special as it does not need to have a + defined bit width. In addition to the previously mentioned objects, unsized :class:`intbv`, :class:`int` and :class:`long` objects are supported, as well as signals of such objects.