[libcamera-devel] [PATCH 2/2] Documentation: Fix list indentation

Kieran Bingham kieran.bingham at ideasonboard.com
Tue Nov 28 13:00:50 CET 2023


Quoting Laurent Pinchart via libcamera-devel (2023-11-28 11:52:58)
> reStructuredText requires list items to be indented. Fix the few
> offenders in the documentation.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart at ideasonboard.com>

I actually think this is more readable in the text too so double win.

Reviewed-by: Kieran Bingham <kieran.bingham at ideasonboard.com>

> ---
>  Documentation/python-bindings.rst | 10 +++++-----
>  README.rst                        |  8 ++++----
>  2 files changed, 9 insertions(+), 9 deletions(-)
> 
> diff --git a/Documentation/python-bindings.rst b/Documentation/python-bindings.rst
> index bac5cd344de3..ed9f686b311a 100644
> --- a/Documentation/python-bindings.rst
> +++ b/Documentation/python-bindings.rst
> @@ -17,13 +17,13 @@ chapter lists the differences.
>  Mostly these differences fall under two categories:
>  
>  1. Differences caused by the inherent differences between C++ and Python.
> -These differences are usually caused by the use of threads or differences in
> -C++ vs Python memory management.
> +   These differences are usually caused by the use of threads or differences in
> +   C++ vs Python memory management.
>  
>  2. Differences caused by the code being work-in-progress. It's not always
> -trivial to create a binding in a satisfying way, and the current bindings
> -contain simplified versions of the C++ API just to get forward. These
> -differences are expected to eventually go away.
> +   trivial to create a binding in a satisfying way, and the current bindings
> +   contain simplified versions of the C++ API just to get forward. These
> +   differences are expected to eventually go away.
>  
>  Coding Style
>  ------------
> diff --git a/README.rst b/README.rst
> index 4a6eb2525f6b..a8b91a26983a 100644
> --- a/README.rst
> +++ b/README.rst
> @@ -188,8 +188,8 @@ the build.ninja module. This is a snippet of the error message.
>  
>  This can be solved in two ways:
>  
> -1) Don't install meson again if it is already installed system-wide.
> +1. Don't install meson again if it is already installed system-wide.
>  
> -2) If a version of meson which is different from the system-wide version is
> -already installed, uninstall that meson using pip3, and install again without
> -the --user argument.
> +2. If a version of meson which is different from the system-wide version is
> +   already installed, uninstall that meson using pip3, and install again without
> +   the --user argument.
> -- 
> Regards,
> 
> Laurent Pinchart
>


More information about the libcamera-devel mailing list