[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [PATCH-for-6.2? v2 1/5] docs/devel/style: Render C types as monospac
From: |
Alex Bennée |
Subject: |
Re: [PATCH-for-6.2? v2 1/5] docs/devel/style: Render C types as monospaced text |
Date: |
Wed, 15 Dec 2021 14:20:54 +0000 |
User-agent: |
mu4e 1.7.5; emacs 28.0.90 |
Philippe Mathieu-Daudé <philmd@redhat.com> writes:
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
> docs/devel/style.rst | 59 ++++++++++++++++++++++----------------------
> 1 file changed, 30 insertions(+), 29 deletions(-)
>
> diff --git a/docs/devel/style.rst b/docs/devel/style.rst
> index e00af62e763..3e519dc6ade 100644
> --- a/docs/devel/style.rst
> +++ b/docs/devel/style.rst
> @@ -111,7 +111,7 @@ Variables are lower_case_with_underscores; easy to type
> and read. Structured
> type names are in CamelCase; harder to type but standing out. Enum type
> names and function type names should also be in CamelCase. Scalar type
> names are lower_case_with_underscores_ending_with_a_t, like the POSIX
> -uint64_t and family. Note that this last convention contradicts POSIX
> +``uint64_t`` and family. Note that this last convention contradicts POSIX
> and is therefore likely to be changed.
>
> Variable Naming Conventions
> @@ -290,57 +290,57 @@ a few useful guidelines here.
> Scalars
> -------
>
> -If you're using "int" or "long", odds are good that there's a better type.
> -If a variable is counting something, it should be declared with an
> -unsigned type.
> +If you're using '``int``' or '``long``', odds are good that there's a
> better
We seem to be switching between quoted and unquoted ``types``. Are the
quotes really needed if they are also highlighted by the monospace font?
Either way:
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
--
Alex Bennée
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- Re: [PATCH-for-6.2? v2 1/5] docs/devel/style: Render C types as monospaced text,
Alex Bennée <=