My English stinks, thank you for patching it!

As a non native English speaker, writing good documentation is a hard task for me and often grammatical and spelling errors slip into my modules pod causing me great embarrassment.

I could use the spell checker more often*, but writing documentation is already a time consuming task, no fun, and well, I am lazy. In any case, that would not solve the grammatical errors.

The thing is that from time to time somebody sends me a patch correcting some of these errors and I want to say publicly how much I appreciate that kind of contribution.

A special mention goes to the Debian QA team, who seems to systematically revise the documentation of everything packed for Debian. That can't be much fun, but they keep doing it.

So, to all of you who have sent me documentation patches over the years, thank you very much, really.


[*] I know, I could move to Dist::Zilla and use some plugin that would do that for me automatically, or at least it would remind me to do it. But I use several computers for development (my PC at work, my PC at home, my PC at my parents home, my laptop, my other laptop, my netbook, an old SunBlade 100 running OpenBSD for sparc64 and another one running Solaris). Also people use my modules on a wide range of operating systems and report bugs specific to those; it is not uncommon for me to create a new virtual machine, install some operating system from scratch, clone the git repository, solve the problem and create a new module distribution just from there. So I try to keep my working dependencies to a minimum (just git).

5 Comments

The Dist-Zilla plugin seems to just use Test::Spelling, in case you want to have it automated without needing to switch just for that :)

I've learnt to get over the embarassment and write anyway :)

This can't be very funny, but they keep doing it.

I think you mean "This can't be very fun, but they keep doing it".

I think he really meant "That can't be much fun, but they keep doing it".

I think you meant "remind" not remain. (use some plugin that would do that for me automatically, or at least it would remain me to do it).

Leave a comment

About Salvador Fandiño

user-pic yaph