[libcamera-devel] libcamera: controls: Fix minor error in documentation
diff mbox series

Message ID 20210716073126.1949-1-jacopo@jmondi.org
State Accepted
Headers show
Series
  • [libcamera-devel] libcamera: controls: Fix minor error in documentation
Related show

Commit Message

Jacopo Mondi July 16, 2021, 7:31 a.m. UTC
Fix a small spelling mistake in the ControlInfoMap documentation.

Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
---
 src/libcamera/controls.cpp | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Kieran Bingham July 16, 2021, 7:52 a.m. UTC | #1
On 16/07/2021 08:31, Jacopo Mondi wrote:
> Fix a small spelling mistake in the ControlInfoMap documentation.
> 
> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>

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

> ---
>  src/libcamera/controls.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
> index 34317fa0f65d..78109f4130a8 100644
> --- a/src/libcamera/controls.cpp
> +++ b/src/libcamera/controls.cpp
> @@ -592,7 +592,7 @@ std::string ControlInfo::toString() const
>   *
>   * The ControlInfoMap class describes controls supported by an object as an
>   * unsorted map of ControlId pointers to ControlInfo instances. Unlike the
> - * standard std::unsorted_map<> class, it is designed the be immutable once
> + * standard std::unsorted_map<> class, it is designed to be immutable once
>   * constructed, and thus only exposes the read accessors of the
>   * std::unsorted_map<> base class.
>   *
>
Paul Elder July 16, 2021, 9:07 a.m. UTC | #2
Hi Jacopo,

On Fri, Jul 16, 2021 at 09:31:26AM +0200, Jacopo Mondi wrote:
> Fix a small spelling mistake in the ControlInfoMap documentation.
> 
> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>

Reviewed-by: Paul Elder <paul.elder@ideasonboard.com>

> ---
>  src/libcamera/controls.cpp | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
> index 34317fa0f65d..78109f4130a8 100644
> --- a/src/libcamera/controls.cpp
> +++ b/src/libcamera/controls.cpp
> @@ -592,7 +592,7 @@ std::string ControlInfo::toString() const
>   *
>   * The ControlInfoMap class describes controls supported by an object as an
>   * unsorted map of ControlId pointers to ControlInfo instances. Unlike the
> - * standard std::unsorted_map<> class, it is designed the be immutable once
> + * standard std::unsorted_map<> class, it is designed to be immutable once
>   * constructed, and thus only exposes the read accessors of the
>   * std::unsorted_map<> base class.
>   *
> -- 
> 2.32.0
>
Umang Jain July 18, 2021, 2:39 p.m. UTC | #3
Hi Jacopo,

Thanks for the patch.

On 7/16/21 1:01 PM, Jacopo Mondi wrote:
> Fix a small spelling mistake in the ControlInfoMap documentation.
>
> Signed-off-by: Jacopo Mondi <jacopo@jmondi.org>
Reviewed-by: Umang Jain <umang.jain@ideasonboard.com>
> ---
>   src/libcamera/controls.cpp | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
> index 34317fa0f65d..78109f4130a8 100644
> --- a/src/libcamera/controls.cpp
> +++ b/src/libcamera/controls.cpp
> @@ -592,7 +592,7 @@ std::string ControlInfo::toString() const
>    *
>    * The ControlInfoMap class describes controls supported by an object as an
>    * unsorted map of ControlId pointers to ControlInfo instances. Unlike the
> - * standard std::unsorted_map<> class, it is designed the be immutable once
> + * standard std::unsorted_map<> class, it is designed to be immutable once
>    * constructed, and thus only exposes the read accessors of the
>    * std::unsorted_map<> base class.
>    *

Patch
diff mbox series

diff --git a/src/libcamera/controls.cpp b/src/libcamera/controls.cpp
index 34317fa0f65d..78109f4130a8 100644
--- a/src/libcamera/controls.cpp
+++ b/src/libcamera/controls.cpp
@@ -592,7 +592,7 @@  std::string ControlInfo::toString() const
  *
  * The ControlInfoMap class describes controls supported by an object as an
  * unsorted map of ControlId pointers to ControlInfo instances. Unlike the
- * standard std::unsorted_map<> class, it is designed the be immutable once
+ * standard std::unsorted_map<> class, it is designed to be immutable once
  * constructed, and thus only exposes the read accessors of the
  * std::unsorted_map<> base class.
  *