Skip to content

Commit 12064f0

Browse files
MichaelOrlovfujitatomoya
authored andcommitted
Add dot at the end of sentences per code review
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Michael Orlov <morlovmr@gmail.com> Signed-off-by: Michael Orlov <michael.orlov@apex.ai>
1 parent c27486d commit 12064f0

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

source/The-ROS2-Project/Contributing/Code-Style-Language-Versions.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -163,10 +163,10 @@ Doxygen Comments
163163
~~~~~~~~~~~~~~~~
164164

165165
* While it is allowed to use ``/** */`` style comments for documentation, we prefer ``///`` style
166-
comments for Doxygen
166+
comments for Doxygen.
167167

168-
* rationale: ``///`` is more consistent with the rest of the C++ code
169-
* rationale: ``///`` is easier to type and read in most editors
168+
* rationale: ``///`` is more consistent with the rest of the C++ code.
169+
* rationale: ``///`` is easier to type and read in most editors.
170170
* rationale: The Doxygen comments with ``///`` is easier to read in the code itself, as it is
171171
more compact versus ``/** */`` which takes up more space and requires more lines.
172172
* Note that using ``/** */`` Doxygen comments is useful in cases when C++ header files could

0 commit comments

Comments
 (0)