[libcamera-devel] Documentation: coding-style: Fix ordered lists

3693 diff mbox series

The syntax used for ordered lists is incorrect. Fix it.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/coding-style.rst | 12 ++++++------
 1 file changed, 6 insertions(+), 6 deletions(-)

Hi Laurent,

Thanks for your fix.

On 2020-05-06 23:29:21 +0300, Laurent Pinchart wrote:
> The syntax used for ordered lists is incorrect. Fix it.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

Reviewed-by: Niklas Söderlund <niklas.soderlund@ragnatech.se>

> ---
>  Documentation/coding-style.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst
> index 95ca04f6150f..dfbbf28df8e7 100644
> --- a/Documentation/coding-style.rst
> +++ b/Documentation/coding-style.rst
> @@ -72,10 +72,10 @@ self-contained.
>  
>  The headers shall be grouped and ordered as follows.
>  
> - # The header declaring the API being implemented (if any)
> - # The C and C++ system and standard library headers
> - # Other libraries' headers, with one group per library
> - # Other project's headers
> +1. The header declaring the API being implemented (if any)
> +2. The C and C++ system and standard library headers
> +3. Other libraries' headers, with one group per library
> +4. Other project's headers
>  
>  Groups of headers shall be separated by a single blank line. Headers within
>  each group shall be sorted alphabetically.
> @@ -118,7 +118,7 @@ reference means using a reference passed by a caller without ownership transfer
>  based on the assumption that the caller guarantees the validity of the
>  reference for the duration of the operation that borrows it.
>  
> -#. Single Owner Objects
> +1. Single Owner Objects
>  
>     * By default an object has a single owner at any time.
>     * Storage of single owner objects varies depending on how the object
> @@ -155,7 +155,7 @@ reference for the duration of the operation that borrows it.
>         otherwise specified, pointers passed to functions are considered as
>         borrowed references valid for the duration of the function only.
>  
> -#. Shared Objects
> +2. Shared Objects
>  
>     * Objects that may have multiple owners at a given time are called shared
>       objects. They are reference-counted and live as long as any references to
> -- 
> Regards,
> 
> Laurent Pinchart
> 
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel

Hi Laurent,

On 06/05/2020 21:29, Laurent Pinchart wrote:
> The syntax used for ordered lists is incorrect. Fix it.
> 
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  Documentation/coding-style.rst | 12 ++++++------
>  1 file changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/coding-style.rst b/Documentation/coding-style.rst
> index 95ca04f6150f..dfbbf28df8e7 100644
> --- a/Documentation/coding-style.rst
> +++ b/Documentation/coding-style.rst

Wow, I actually didn't realise/forgot this page existed because it has
so little visibility.

I'll try to work on improving the global site map so content can be
identified easily rather than being hidden through small links in other
pages.

> @@ -72,10 +72,10 @@ self-contained.
>  
>  The headers shall be grouped and ordered as follows.
>  
> - # The header declaring the API being implemented (if any)
> - # The C and C++ system and standard library headers
> - # Other libraries' headers, with one group per library
> - # Other project's headers
> +1. The header declaring the API being implemented (if any)
> +2. The C and C++ system and standard library headers
> +3. Other libraries' headers, with one group per library
> +4. Other project's headers

That indentation has been changed. The formatting of the website doesn't
update correctly, but that could be due to the CSS styles over the
indentation, so I'll validate that next.

Other than that,

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

>  
>  Groups of headers shall be separated by a single blank line. Headers within
>  each group shall be sorted alphabetically.
> @@ -118,7 +118,7 @@ reference means using a reference passed by a caller without ownership transfer
>  based on the assumption that the caller guarantees the validity of the
>  reference for the duration of the operation that borrows it.
>  
> -#. Single Owner Objects
> +1. Single Owner Objects
>  
>     * By default an object has a single owner at any time.
>     * Storage of single owner objects varies depending on how the object
> @@ -155,7 +155,7 @@ reference for the duration of the operation that borrows it.
>         otherwise specified, pointers passed to functions are considered as
>         borrowed references valid for the duration of the function only.
>  
> -#. Shared Objects
> +2. Shared Objects
>  
>     * Objects that may have multiple owners at a given time are called shared
>       objects. They are reference-counted and live as long as any references to
>