Documentation: doc-guide: use '%' constant indicator in Return: examples
authorRandy Dunlap <rdunlap@infradead.org>
Mon, 3 Jul 2023 23:20:30 +0000 (16:20 -0700)
committerJonathan Corbet <corbet@lwn.net>
Fri, 14 Jul 2023 19:16:59 +0000 (13:16 -0600)
commitc15ec3d1a287698830798111ede1b7ae0bfef7f6
tree4b8a01275cc350cedd70eebcd7bfa38a707c1070
parentfcb4a2e4cce75be6ef95e4015419a45a6e85f1b2
Documentation: doc-guide: use '%' constant indicator in Return: examples

Use the 'constant' indicator '%' in the examples for the
Return: values syntax. This can help encourage people to use it.

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Suggested-by: Steven Rostedt <rostedt@goodmis.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Link: https://lore.kernel.org/lkml/20221121154358.36856ca6@gandalf.local.home/
Acked-by: Steven Rostedt (Google) <rostedt@goodmis.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20230703232030.8223-1-rdunlap@infradead.org
Documentation/doc-guide/kernel-doc.rst