Re: [HACKERS] Possible spelling fixes - Mailing list pgsql-hackers

From Heikki Linnakangas
Subject Re: [HACKERS] Possible spelling fixes
Date
Msg-id b3bf24f5-fa00-9c20-3c92-9b652e7e0917@iki.fi
Whole thread Raw
In response to Re: [HACKERS] Possible spelling fixes  (Josh Soref <jsoref@gmail.com>)
Responses Re: [HACKERS] Possible spelling fixes
Re: [HACKERS] Possible spelling fixes
List pgsql-hackers
On 02/06/2017 04:50 AM, Josh Soref wrote:
> It's now split more or less to your suggestion:
> https://github.com/jsoref/postgres/commits/spelling

Thanks!

I pushed most of these. Except for the below:

> optimisation -> optimization et al.

Most of our code is written with the American spelling, but the British 
spelling isn't wrong, so I don't want to go around changing them all.

> NUL-terminated -> NULL-terminated

When we're talking about NUL-terminated strings, NUL refers to the NUL 
ASCII character. NULL usually refers to a NULL pointer. We're probably 
not consistent about this, but in this context, NUL-terminated isn't 
wrong, so let's leave them as they are.

> Ooops -> Oops

"Oops" is more idiomatic, but this doesn't really seem worth changing. 
Maybe "Ooops" indicates a slightly bigger mistake than "oops" :-)

> re-entrancy -> reentrancy

Googling around, I can see both spellings being used. "Re-entrancy" 
actually feels more natural to me, although I'm not sure which is more 
correct. Let's leave them as they are.

> passthru -> passthrough

"Passthrough" is clearly the correct spelling (or "pass-through"?), but 
"passthru" seems OK in the context, as an informal shorthand.

> --- a/src/backend/tsearch/dict_thesaurus.c
> +++ b/src/backend/tsearch/dict_thesaurus.c
> @@ -23,7 +23,7 @@
>
>
>  /*
> - * Temporay we use TSLexeme.flags for inner use...
> + * Temporary we use TSLexeme.flags for inner use...
>   */
>  #define DT_USEASIS             0x1000

Looking at the code real quick, I couldn't understand the original 
meaning of this. Is it:

* DT_USEASIS is a temporary value we use for something. For what?

* DT_USEASIS is used temporarily for something. Does this mean, 
"temporarily" until we get around to write the code differently, or does 
it happen temporarily at runtime, or what?

Just fixing the typo doesn't help much here, and I'm not sure if it 
should be "temporary" or "temporarily" anyway.

> --- a/contrib/spi/timetravel.c
> +++ b/contrib/spi/timetravel.c
> @@ -51,7 +51,7 @@ static EPlan *find_plan(char *ident, EPlan **eplan, int *nplans);
>   *                     and stop_date eq INFINITY [ and update_user eq current user ]
>   *                     and all other column values as in new tuple, and insert tuple
>   *                     with old data and stop_date eq current date
> - *                     ELSE - skip updation of tuple.
> + *                     ELSE - skip UPDATE of tuple.
>   *             2.  IF a delete affects tuple with stop_date eq INFINITY
>   *                     then insert the same tuple with stop_date eq current date
>   *                     [ and delete_user eq current user ]

I wasn't sure if this changes the meaning of the comment slightly. An 
"UPDATE" in all-caps refers to an UPDATE statement, is that what's meant 
here? Or just updating a tuple, i.e. should this rather be "skip 
updating of the tuple" or "skip update of tuple"?

> --- a/src/test/regress/sql/errors.sql
> +++ b/src/test/regress/sql/errors.sql
> @@ -2,7 +2,7 @@
>  -- ERRORS
>  --
>
> --- bad in postquel, but ok in postsql
> +-- bad in postquel, but ok in PostgreSQL
>  select 1;

This "postsql" refers to the SQL dialect of PostgreSQL, rather than 
PostgreSQL the project. I don't remember seeing it called "postsql" 
anywhere else, though. We hardly care about what was an error in 
postqual anyway, though, so perhaps this should be rewritten into 
something else entirely, like "This is not allowed by the SQL standard, 
but ok on PostgreSQL" (assuming that's correct, I'm not 100% sure). Or 
just leave it alone.

Thanks for the fixes! I was particularly impressed that you caught the 
typo in Marcel Kornacker's surname.

- Heikki



pgsql-hackers by date:

Previous
From: Fabien COELHO
Date:
Subject: Re: \if, \elseif, \else, \endif (was Re: [HACKERS] PSQL commands:\quit_if, \quit_unless)
Next
From: Heikki Linnakangas
Date:
Subject: Re: [HACKERS] Variable name typo in launcher.c