Skip to content

Commit 5784ddd

Browse files
committed
vale fixes
1 parent ad035bc commit 5784ddd

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

source/code-documentation.txt

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ documentation tool, for its code documentation.
2626
Structure
2727
---------
2828

29-
- **Modules:** All class and module definitions should be preceded by
29+
- **Modules:** All class and module definitions must be preceded by
3030
a documentation comment.
3131

3232
.. code-block:: ruby
@@ -35,7 +35,7 @@ Structure
3535
# what they do with corrugated cardboard these days.
3636
class CardboardBox
3737

38-
- **Methods:** All method definitions should be preceded by a
38+
- **Methods:** All method definitions must be preceded by a
3939
documentation comment. Use ``@param``, ``@yield``, and ``@return`` to
4040
specify inputs and output. To learn more, see the
4141
:ref:`mongoid-code-documentation-type-declaration` section.
@@ -70,7 +70,7 @@ Structure
7070
def do_something_obvious
7171

7272
- **API Private:** Classes and public methods which are not intended for
73-
external usage should be marked ``@api private``. This macro does not
73+
external usage must be marked ``@api private``. This macro does not
7474
require a comment.
7575

7676
Note that, because {+odm+}'s modules are mixed into application classes,
@@ -117,7 +117,7 @@ Formatting
117117
.. code-block:: ruby
118118

119119
# This is the description of the method. Line wraps in the description
120-
# should not be indented.
120+
# must not be indented.
121121
#
122122
# @return [ Symbol ] For macros, wraps must be double-space indented
123123
# on the second, third, etc. lines.
@@ -307,7 +307,7 @@ Type Declaration
307307

308308
- **Blocks:** If the method explicitly specifies a block argument, specify the block
309309
argument using ``@param`` preceded by an ampersand ``&``, and also specify ``@yield``.
310-
Note ``@yield`` should be used even when method calls ``block.call`` rather than
310+
Note ``@yield`` must be used even when method calls ``block.call`` rather than
311311
``yield`` internally.
312312

313313
.. code-block:: ruby
@@ -340,7 +340,7 @@ Type Declaration
340340
yield(:peacock, :conservatory, :wrench)
341341
end
342342

343-
- **Proc Args:** Proc arguments should use ``@param`` (not ``@yield``). The
343+
- **Proc Args:** Proc arguments must use ``@param`` (not ``@yield``). The
344344
inputs to the proc may be specified as subtype(s).
345345

346346
.. code-block:: ruby

0 commit comments

Comments
 (0)