Skip to content

Commit 6ece205

Browse files
committed
Adding doc-string.
1 parent 0e12606 commit 6ece205

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

commpy/channels.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,20 @@
1616
# You should have received a copy of the GNU General Public License
1717
# along with this program. If not, see <http://www.gnu.org/licenses/>.
1818

19+
"""
20+
============================================
21+
Channel Models (:mod:`commpy.channels`)
22+
============================================
23+
24+
.. autosummary::
25+
:toctree: generated/
26+
27+
bec -- Binary Erasure Channel.
28+
bsc -- Binary Symmetric Channel.
29+
awgn -- Additive White Gaussian Noise Channel.
30+
31+
"""
32+
1933
from numpy import complex, sum, pi, arange, array, size, shape, real, sqrt
2034
from numpy import matrix, sqrt, sum, zeros, concatenate, sinc
2135
from numpy.random import randn, seed, random

0 commit comments

Comments
 (0)