[libcamera-devel,v4] documentation: guides: pipeline-handler: Fix spelling error
diff mbox series

Message ID 20230304103758.9154-1-advaitdhamorikar@gmail.com
State Accepted
Commit cee03cd183126d1e0828c8ae2cc8706de2404b73
Headers show
Series
  • [libcamera-devel,v4] documentation: guides: pipeline-handler: Fix spelling error
Related show

Commit Message

Advait Dhamorikar March 4, 2023, 10:37 a.m. UTC
The pipeline handler writers guide incorrectly references the
VividCameradata::init() impelementation with a spelling error

Fix spelling of "impelementation" in the pipeline handler development guide

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

Signed-off-by: Advait Dhamorikar <advaitdhamorikar@gmail.com>
---
Hello Kieran,
Thanks for the review, here's another version with the mentioned changes,
I'm currently studying how simple-cam works, looking forward to contribute more.

Regards,
Advait

 Documentation/guides/pipeline-handler.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Laurent Pinchart March 6, 2023, 11:09 a.m. UTC | #1
Hi Advait,

Thank you for the patch.

On Sat, Mar 04, 2023 at 04:07:58PM +0530, Advait Dhamorikar via libcamera-devel wrote:
> The pipeline handler writers guide incorrectly references the
> VividCameradata::init() impelementation with a spelling error

Sentences should end with a period.

> 
> Fix spelling of "impelementation" in the pipeline handler development guide

And lines in the commit message should be wrapped at 72 columns.

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

Tags should be grouped together, this blank line can be dropped. I'll
fix this locally, no need to send a new version.

> Signed-off-by: Advait Dhamorikar <advaitdhamorikar@gmail.com>

Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>

> ---
> Hello Kieran,
> Thanks for the review, here's another version with the mentioned changes,
> I'm currently studying how simple-cam works, looking forward to contribute more.
> 
> Regards,
> Advait
> 
>  Documentation/guides/pipeline-handler.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst
> index e1930fdf..4d38fa23 100644
> --- a/Documentation/guides/pipeline-handler.rst
> +++ b/Documentation/guides/pipeline-handler.rst
> @@ -1409,7 +1409,7 @@ function to the V4L2 device buffer signal.
>     video_->bufferReady.connect(this, &VividCameraData::bufferReady);
>  
>  Create the matching ``VividCameraData::bufferReady`` function after your
> -VividCameradata::init() impelementation.
> +VividCameradata::init() implementation.
>  
>  The ``bufferReady`` function obtains the request from the buffer using the
>  ``request`` function, and notifies the ``Camera`` that the buffer and

Patch
diff mbox series

diff --git a/Documentation/guides/pipeline-handler.rst b/Documentation/guides/pipeline-handler.rst
index e1930fdf..4d38fa23 100644
--- a/Documentation/guides/pipeline-handler.rst
+++ b/Documentation/guides/pipeline-handler.rst
@@ -1409,7 +1409,7 @@  function to the V4L2 device buffer signal.
    video_->bufferReady.connect(this, &VividCameraData::bufferReady);
 
 Create the matching ``VividCameraData::bufferReady`` function after your
-VividCameradata::init() impelementation.
+VividCameradata::init() implementation.
 
 The ``bufferReady`` function obtains the request from the buffer using the
 ``request`` function, and notifies the ``Camera`` that the buffer and