No description
e1f10ab7df
Thought I was done with doc-comments, but then I noticed that there wasn't a clear indication in the html about which properties were settable and which were read only. I also discovered that several properties that could raise ValueError weren't marked as such. (technically they were in the code, but Sphinx was ignoring that) Changes: 1. Systematic :getter: and :setter: attributes for properties 2. Move `:raises: ...` from setter comments to getter comments so they show up in the html doc. This particularly applies to setters that use constants. 3. Change `:return: ...` to `:getter: ...` for getter functions |
||
|---|---|---|
| .github | ||
| docs | ||
| examples | ||
| LICENSES | ||
| .gitignore | ||
| .pre-commit-config.yaml | ||
| .readthedocs.yaml | ||
| adafruit_tlv320.py | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| optional_requirements.txt | ||
| pyproject.toml | ||
| README.rst | ||
| README.rst.license | ||
| requirements.txt | ||
| ruff.toml | ||
SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries SPDX-FileCopyrightText: Copyright (c) 2025 Liz Clark for Adafruit Industries SPDX-License-Identifier: MIT