docs(prof.py): overhaul documentation to align with Google Python Style Guide

Browse Source

- Updated project references from Profanity to CProof.
- Removed Python 2 and unicode references.
- Added type hints for all parameters and return types.
- Organized functions into logical sections with RST comments for Sphinx.
- Improved wording for clarity and precision based on source code analysis.
- Ensured compliance with Google Python Style Guide for readable docstrings.

Related to #30

...

This commit is contained in:

Jabber Developer

2025-09-10 18:10:37 +02:00

parent c94cd0b549

commit 052e168e9b

1 changed files with 904 additions and 614 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

1518

apidocs/python/src/prof.py

File diff suppressed because it is too large Load Diff