From f284012a3339da72910d56cf47864ccf9e49fe26 Mon Sep 17 00:00:00 2001 From: thindil Date: Fri, 12 Apr 2024 06:09:43 +0000 Subject: [PATCH] docs: updated code documentation for objects rules FossilOrigin-Name: 5d75af86ddfa34911c4eb5e6e2e2d711bc241802d2a6a29a33c8d1dd4dc5afaf --- src/rules/objects.nim | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/src/rules/objects.nim b/src/rules/objects.nim index 4b68b8a..8d3eb70 100644 --- a/src/rules/objects.nim +++ b/src/rules/objects.nim @@ -47,9 +47,11 @@ ## * objects is the name of the rule. It is case-insensitive, thus it can be ## set as *objects*, *objects* or *oBjEcTs*. ## * checkType is the type of checks to perform on the objects' declarations. Proper -## values are: *publicfields*, *all*. Setting it to publicfieds will check existence of -## objects declarations which not contains public fields. Setting it to all will -## perform all checks. +## values are: *publicfields*, *all*, *standardtypes*. Setting it to publicfieds +## will check existence of objects declarations which contains public fields. +## Setting it to *standardtypes* will check existence of objects' declarations +## which contains fields with string or int type. Setting it to all will perform +## all checks. ## ## Disabling the rule ## ------------------ @@ -75,9 +77,9 @@ ## Examples ## -------- ## -## 1. Check if all objects' types' declarations contains public fields:: +## 1. Check if all objects' types' declarations contains public fields and standard types:: ## -## check objects publicfields +## check objects all ## ## 2. Made all object's types' fields private:: ##