Re: [PATCH v2 RESEND] Documentation: doc-guide: use '%' constant indicator in Return: examples

[Jonathan Corbet]

Randy Dunlap <rdunlap@xxxxxxxxxxxxx> writes:

> 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@xxxxxxxxxxxxx>
> Suggested-by: Steven Rostedt <rostedt@xxxxxxxxxxx>
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Cc: linux-doc@xxxxxxxxxxxxxxx
> Link: https://lore.kernel.org/lkml/20221121154358.36856ca6@xxxxxxxxxxxxxxxxxx/
> Acked-by: Steven Rostedt (Google) <rostedt@xxxxxxxxxxx>
> ---
> v2: in Subject, spell 'examples' correctly;
>     Add Link: and Acked-by: Steven
>     add Note:
>
> Note: %-ECODE or -%ECODE both work well.
>
>  Documentation/doc-guide/kernel-doc.rst |   10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)

I'm not convinced that this %notation really helps the documentation
rather than just cluttering...but for now we have it, so I've applied
this.

Thanks,

jon