Skip to content

Commit c8893ec

Browse files
authored
Merge pull request #15939 from ethereum/release_checklist_remove_double_backticks
Remove double backticks and indented bullet points from Markdown files
2 parents 40a4d5d + 70d344a commit c8893ec

File tree

2 files changed

+102
-102
lines changed

2 files changed

+102
-102
lines changed

CODING_STYLE.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -110,9 +110,9 @@ Use `solAssert` and `solUnimplementedAssert` generously to check assumptions tha
110110
4. Favour declarations close to use; do not habitually declare at top of scope ala C.
111111
5. Pass non-trivial parameters as const reference, unless the data is to be copied into the function, then either pass by const reference or by value and use std::move.
112112
6. If a function returns multiple values, use std::tuple (std::pair acceptable) or better introduce a struct type. Do not use */& arguments.
113-
7. Use parameters of pointer type only if ``nullptr`` is a valid argument, use references otherwise. Often, ``std::optional`` is better suited than a raw pointer.
113+
7. Use parameters of pointer type only if `nullptr` is a valid argument, use references otherwise. Often, `std::optional` is better suited than a raw pointer.
114114
8. Never use a macro where adequate non-preprocessor C++ can be written.
115-
9. Only use ``auto`` if the type is very long and rather irrelevant.
115+
9. Only use `auto` if the type is very long and rather irrelevant.
116116
10. Do not pass bools: prefer enumerations instead.
117117
11. Prefer enum class to straight enum.
118118
12. Always initialize POD variables, even if their value is overwritten later.

0 commit comments

Comments
 (0)