Skip to content

Commit c69b763

Browse files
committed
docs: add note to --suffix
1 parent dfc8e9d commit c69b763

1 file changed

Lines changed: 7 additions & 0 deletions

File tree

user_guide_src/source/cli/cli_generators.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,13 @@ Options:
112112
* ``--suffix``: Append the component suffix to the generated class name.
113113
* ``--force``: Set this flag to overwrite existing files on destination.
114114

115+
.. note:: If you use ``--suffix``, the generated controller name will be like
116+
``ProductController``. That violates the Controller naming convention
117+
when using :ref:`Auto Routing <controller-auto-routing-improved>`
118+
(Controller class names MUST start with an uppercase letter and
119+
ONLY the first character can be uppercase). So ``--suffix`` can be used
120+
when you use :ref:`Defined Routes <defined-route-routing>`.
121+
115122
make:entity
116123
-----------
117124

0 commit comments

Comments
 (0)