Improve codebase #249

torik42 · 2023-03-24T20:22:29Z

This PR combines various improvements of the codebase.

Use absolute imports for better readability.
Add docstrings to yalafi for hints in IDEs and Sphinx documentation.
Refactor some parts for readability.
Remove Trailing spaces.
Add Pylint configuration to pyproject.toml
Replace bare exceptions except: with except Exception:, since “a bare except: clause will catch SystemExit and KeyboardInterrupt exceptions” (see PEP8)

Add configuration for Pylint to `pyproject.toml` and hide some unnecessary warnings.

As suggested by Pylint. We still do `except Exception` since the problem is presented to the user over stderr.

torik42 added 5 commits March 24, 2023 20:49

Use absolute imports for better readability

4353205

Add docstrings to yalafi modules

8c06fb8

Refactor for readability and stability

48b4de7

Use Pylint and hide some of its warnings

0ad4c74

Add configuration for Pylint to `pyproject.toml` and hide some unnecessary warnings.

Remove bare exceptions

78b177e

As suggested by Pylint. We still do `except Exception` since the problem is presented to the user over stderr.

torik42 merged commit 2ba4635 into master Mar 24, 2023

torik42 deleted the improve-codebase branch March 24, 2023 20:34

torik42 mentioned this pull request Mar 24, 2023

Documentation overhaul #248

Open

9 tasks

Provide feedback