Re: Pod "banned words" check?

On Thu, 11 Dec 2025 at 01:46, Paul Johnson via perl5-porters <
[email protected]> wrote:

> On 7 December 2025 12:30:30 Dave Mitchell <[email protected]> wrote:
>
> On Sat, Dec 06, 2025 at 08:43:16AM -0800, Karen Etheridge wrote:
>>
>>> As a British speaker, I often unwittingly write words like
>>>> "unrecognised" in Perl code, only to later find that we standardised ^W
>>>> standardized on US English spelling, and have to fix it.
>>>>
>>>>
>>> Did we? Is this a written policy?
>>>
>>
>> I don't think we did!
>>
>> I usually write code comments and core documentation using British
>> English. For some reason a surprising number of senior p5pers over the
>> years have been from the UK; and with that safety in numbers, we've been
>> able to smuggle in our language quirks.
>>
>> (Gor blimey guv, luv a duck! Etc.)
>>
>
> I seem to recall Nicholas writing, quite some time ago, that whoever wrote
> the documentation got to decide on the EN variant to use, but that we try
> to keep consistency within individual documents where possible.  And this
> always seemed a sensible policy to me.
>
> I suppose the policy never got formally documented.  And I've not searched
> the p5p archives to confirm my memories.
>
> (And I've also failed to include anything in this message to demonstrate
> my preference.)
>
>
IMHO documentation style should be consistent across documentation of
single unit (in case of perl5 sources it will be perl5 and ext modules)

As non-native speaker I started to use LLMs for proofreading of my
documentation with instruction:
I favour British spelling with an exception of word license.

Maybe providing recommended proofread-perl-documentation-prompt.txt may be
the way ?




> --
> Paul Johnson - [email protected]
> http://pjcj.net
>
>