From e9c65b030af1e48fc4812a63bd02bbce5149b9aa Mon Sep 17 00:00:00 2001 From: thindil Date: Fri, 5 Apr 2024 04:17:06 +0000 Subject: [PATCH] docs: updated the project's documentation FossilOrigin-Name: 0e12831e4691559143c204ff1e37b529d0ce1ad3485b535b00e43f7bc3a2c467 --- doc/configuration.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/configuration.rst b/doc/configuration.rst index 2f6cde3..feb6eb7 100644 --- a/doc/configuration.rst +++ b/doc/configuration.rst @@ -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: [*" @@ -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 @@ -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.