aboutsummaryrefslogtreecommitdiffstats
path: root/util/README.md
diff options
context:
space:
mode:
authorcobat <cobat@yandex-team.ru>2022-02-10 16:49:07 +0300
committerDaniil Cherednik <dcherednik@yandex-team.ru>2022-02-10 16:49:07 +0300
commite486e109b08823b61996f2154f0bc6b7c27a4af4 (patch)
treecb98553f871fe96452fd02bd46a1a4e0cf165844 /util/README.md
parent85e7b8b43a12f69b4721aee71dea28491c9bd503 (diff)
downloadydb-e486e109b08823b61996f2154f0bc6b7c27a4af4.tar.gz
Restoring authorship annotation for <cobat@yandex-team.ru>. Commit 1 of 2.
Diffstat (limited to 'util/README.md')
-rw-r--r--util/README.md36
1 files changed, 18 insertions, 18 deletions
diff --git a/util/README.md b/util/README.md
index 496efa633c..b4c4785e77 100644
--- a/util/README.md
+++ b/util/README.md
@@ -4,37 +4,37 @@ Style guide for the util folder is a stricter version of
[general style guide](https://docs.yandex-team.ru/arcadia-cpp/cpp_style_guide)
(mostly in terms of ambiguity resolution).
- * all {} must be in K&R style
- * &, * tied closer to a type, not to variable
- * always use `using` not `typedef`
- * even a single line block must be in braces {}:
+ * all {} must be in K&R style
+ * &, * tied closer to a type, not to variable
+ * always use `using` not `typedef`
+ * even a single line block must be in braces {}:
```
if (A) {
B();
}
```
- * _ at the end of private data member of a class - `First_`, `Second_`
- * every .h file must be accompanied with corresponding .cpp to avoid a leakage and check that it is self contained
- * prohibited to use `printf`-like functions
+ * _ at the end of private data member of a class - `First_`, `Second_`
+ * every .h file must be accompanied with corresponding .cpp to avoid a leakage and check that it is self contained
+ * prohibited to use `printf`-like functions
-Things declared in the general style guide, which sometimes are missed:
+Things declared in the general style guide, which sometimes are missed:
- * `template <`, not `template<`
- * `noexcept`, not `throw ()` nor `throw()`, not required for destructors
- * indents inside `namespace` same as inside `class`
+ * `template <`, not `template<`
+ * `noexcept`, not `throw ()` nor `throw()`, not required for destructors
+ * indents inside `namespace` same as inside `class`
-Requirements for a new code (and for corrections in an old code which involves change of behaviour) in util:
+Requirements for a new code (and for corrections in an old code which involves change of behaviour) in util:
- * presence of UNIT-tests
- * presence of comments in Doxygen style
- * accessors without Get prefix (`Length()`, but not `GetLength()`)
+ * presence of UNIT-tests
+ * presence of comments in Doxygen style
+ * accessors without Get prefix (`Length()`, but not `GetLength()`)
-This guide is not a mandatory as there is the general style guide.
-Nevertheless if it is not followed, then a next `ya style .` run in the util folder will undeservedly update authors of some lines of code.
+This guide is not a mandatory as there is the general style guide.
+Nevertheless if it is not followed, then a next `ya style .` run in the util folder will undeservedly update authors of some lines of code.
-Thus before a commit it is recommended to run `ya style .` in the util folder.
+Thus before a commit it is recommended to run `ya style .` in the util folder.
Don't forget to run tests from folder `tests`: `ya make -t tests`