From db7e64960cb9e101dcddd38cea519dca63a2f371 Mon Sep 17 00:00:00 2001 From: Adam Greig Date: Thu, 18 Jan 2024 00:17:40 +0000 Subject: [PATCH] lib.crc: make module documentation introduction consistent with other stdlib modules. --- amaranth/lib/crc/__init__.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/amaranth/lib/crc/__init__.py b/amaranth/lib/crc/__init__.py index 6fabe55..2411312 100644 --- a/amaranth/lib/crc/__init__.py +++ b/amaranth/lib/crc/__init__.py @@ -1,6 +1,6 @@ """ -Utilities for computing cyclic redundancy checks (CRCs) in software and in -hardware. +The :mod:`amaranth.lib.crc` module provides utilities for computing cyclic +redundancy checks (CRCs) in software and in hardware. CRCs are specified using the :py:class:`Algorithm` class, which contains settings for CRC width, polynomial, initial value, input/output reflection, and