Skip to content

Commit

Permalink
docs: updated the project's documentation
Browse files Browse the repository at this point in the history
FossilOrigin-Name: 0e12831e4691559143c204ff1e37b529d0ce1ad3485b535b00e43f7bc3a2c467
  • Loading branch information
thindil committed Apr 5, 2024
1 parent 0909cdb commit e9c65b0
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions doc/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ lvlError. The settings below checks for:
15. If any `if` statement can be replaced with `case` statement due to large amount of branches.
16. If any code block doesn't exceed limit of cyclomatic complexity.
17. If any `try` statement doesn't have empty `except` branch
18. If all object's type's declarations contains only private fields.

::
check hasPragma procedures contractual "raises: [*" "tags: [*"
Expand Down Expand Up @@ -255,6 +256,9 @@ setting shouldn't contain a new line characters.
check not trystatements empty
explanation Except branches with names of exceptions made code more readable. It also prevents problems when the checked code will start propagating new exceptions.

check not objects publicfields
explanation Each object's declaration should define also getters and setters for its fields. It made maintaining the code easier, when the type will be upgraded or required to use in multithread environment.

Search rules
------------
Search rules are similar to the check rules. The main difference is that they
Expand Down Expand Up @@ -377,3 +381,6 @@ there is no rules configured for the program.

check not trystatements empty
explanation Except branches with names of exceptions made code more readable. It also prevents problems when the checked code will start propagating new exceptions.

check not objects publicfields
explanation Each object's declaration should define also getters and setters for its fields. It made maintaining the code easier, when the type will be upgraded or required to use in multithread environment.

0 comments on commit e9c65b0

Please sign in to comment.