[1/3] Documentation: Rename "API" section to "API Reference"
diff mbox series

Message ID 20240821004007.28938-2-laurent.pinchart@ideasonboard.com
State Accepted
Commit fb45232fe516556c45a7def935ccbe1c87487f39
Headers show
Series
  • Further small documentation improvements
Related show

Commit Message

Laurent Pinchart Aug. 21, 2024, 12:40 a.m. UTC
"API" as a section name is as informative as it is long, that is to say,
not very. Rename it to "API Reference" for improved clarity.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 Documentation/api-html/index.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Dan Scally Aug. 21, 2024, 7:02 a.m. UTC | #1
Hi Laurent

On 21/08/2024 01:40, Laurent Pinchart wrote:
> "API" as a section name is as informative as it is long, that is to say,
> not very. Rename it to "API Reference" for improved clarity.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
Reviewed-by: Daniel Scally <dan.scally@ideasonboard.com>
>   Documentation/api-html/index.rst | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst
> index 9e630fc0e6b4..2f09833d1dc1 100644
> --- a/Documentation/api-html/index.rst
> +++ b/Documentation/api-html/index.rst
> @@ -2,7 +2,7 @@
>   
>   .. _api:
>   
> -API
> -===
> +API Reference
> +=============
>   
>   :: Placeholder for Doxygen documentation

Patch
diff mbox series

diff --git a/Documentation/api-html/index.rst b/Documentation/api-html/index.rst
index 9e630fc0e6b4..2f09833d1dc1 100644
--- a/Documentation/api-html/index.rst
+++ b/Documentation/api-html/index.rst
@@ -2,7 +2,7 @@ 
 
 .. _api:
 
-API
-===
+API Reference
+=============
 
 :: Placeholder for Doxygen documentation