Skip to content

Commit 7d68dd4

Browse files
author
Mark Stapp
committed
doc: encourage const in the developer doc
Add a little text about using 'const' in the dev doc. Signed-off-by: Mark Stapp <[email protected]>
1 parent 5e5e7a6 commit 7d68dd4

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

doc/developer/workflow.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1021,6 +1021,15 @@ JSON Output
10211021

10221022
All JSON keys are to be camelCased, with no spaces.
10231023

1024+
Use of const
1025+
^^^^^^^^^^^^
1026+
1027+
Please consider using ``const`` when possible: it's a useful hint to
1028+
callers about the limits to side-effects from your apis, and it makes
1029+
it possible to use your apis in paths that involve ``const``
1030+
objects. If you encounter existing apis that *could* be ``const``,
1031+
consider including changes in your own pull-request.
1032+
10241033

10251034
.. _documentation:
10261035

0 commit comments

Comments
 (0)