Re: [PATCH 1/4] Docs: Typo: coordinate{,s}

Re: [PATCH 1/4] Docs: Typo: coordinate{,s}

[Arend van Spriel]

On 07/29/2011 02:46 PM, Michael Witten wrote:
> Signed-off-by: Michael Witten<mfwitten@gmail.com>
> ---
>   include/linux/cordic.h |    4 ++--
>   1 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/include/linux/cordic.h b/include/linux/cordic.h
> index f932093..de741da 100644
> --- a/include/linux/cordic.h
> +++ b/include/linux/cordic.h
> @@ -35,8 +35,8 @@ struct cordic_iq {
>    * @theta: angle in degrees for which i/q coordinate is to be calculated.
>    * @coord: function output parameter holding the i/q coordinate.
>    *
> - * The function calculates the i/q coordinate for a given angle using
> - * cordic algorithm. The coordinate consists of a real (i) and an
> + * The function calculates the i/q coordinates for a given angle using
> + * cordic algorithm. The coordinates consist of a real (i) and an
>    * imaginary (q) part. The real part is essentially the cosine of the
>    * angle and the imaginary part is the sine of the angle. The returned
>    * values are scaled by 2^16 for precision. The range for theta is

Most patches in this series are fine by me. However, the function takes 
a single angle as input and returns a single two-dimensional coordinate 
as output. The coordinate itself is represented by the two axis i and q. 
So I tend to say changing coordinate to coordinates is not justified 
here. However, I not a native english speaker so I may be wrong here.

Gr. AvS

-- 
Almost nobody dances sober, unless they happen to be insane.
-- H.P. Lovecraft --

Re: [PATCH 1/4] Docs: Typo: coordinate{,s}

[Michael Witten]

On Fri, Jul 29, 2011 at 13:53, Arend van Spriel <arend@broadcom.com> wrote:
> On 07/29/2011 02:46 PM, Michael Witten wrote:
>>
>> Signed-off-by: Michael Witten<mfwitten@gmail.com>
>> ---
>>  include/linux/cordic.h |    4 ++--
>>  1 files changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/include/linux/cordic.h b/include/linux/cordic.h
>> index f932093..de741da 100644
>> --- a/include/linux/cordic.h
>> +++ b/include/linux/cordic.h
>> @@ -35,8 +35,8 @@ struct cordic_iq {
>>   * @theta: angle in degrees for which i/q coordinate is to be calculated.
>>   * @coord: function output parameter holding the i/q coordinate.
>>   *
>> - * The function calculates the i/q coordinate for a given angle using
>> - * cordic algorithm. The coordinate consists of a real (i) and an
>> + * The function calculates the i/q coordinates for a given angle using
>> + * cordic algorithm. The coordinates consist of a real (i) and an
>>   * imaginary (q) part. The real part is essentially the cosine of the
>>   * angle and the imaginary part is the sine of the angle. The returned
>>   * values are scaled by 2^16 for precision. The range for theta is
>
> Most patches in this series are fine by me. However, the function takes a
> single angle as input and returns a single two-dimensional coordinate as
> output. The coordinate itself is represented by the two axis i and q. So I
> tend to say changing coordinate to coordinates is not justified here.
> However, I not a native english speaker so I may be wrong here.

Sure.

Jiri, I'll send you a pull request later with the update(s).