Re: Helping with documentation

SD
stephane ducasse
Thu, Jan 13, 2022 12:14 PM

On 12 Jan 2022, at 02:03, Jimmie Houchin jlhouchin@gmail.com wrote:

I am going to be working my way through some Pharo docs.

As I read the books I sometimes see some English that can be improved.

Yes I noticed it too but I’m running too fast and my english is not my native language so
it is not good.

What is the proper procedure for doing so?

Any pointers to documents to help with this greatly appreciated.

Oh this is easy just send small PRs and I will read and integrate them.
Thanks in advance because this is important to get better documentation.

S

Thanks.

Jimmie

> On 12 Jan 2022, at 02:03, Jimmie Houchin <jlhouchin@gmail.com> wrote: > > I am going to be working my way through some Pharo docs. > > As I read the books I sometimes see some English that can be improved. Yes I noticed it too but I’m running too fast and my english is not my native language so it is not good. > > What is the proper procedure for doing so? > > Any pointers to documents to help with this greatly appreciated. Oh this is easy just send small PRs and I will read and integrate them. Thanks in advance because this is important to get better documentation. S > > > Thanks. > > > Jimmie
JH
Jimmie Houchin
Fri, Jan 14, 2022 12:25 PM

On 1/13/22 06:14, stephane ducasse wrote:

On 12 Jan 2022, at 02:03, Jimmie Houchin jlhouchin@gmail.com wrote:

I am going to be working my way through some Pharo docs.

As I read the books I sometimes see some English that can be improved.

Yes I noticed it too but I’m running too fast and my english is not my native language so
it is not good.

Your English is just fine. Probably better than half of Americans. :)
But there are probably things that are definitely more noticeable to
native English speakers.

But it is easy to make mistakes and hard to see your own mistakes. I
regularly create documents and then let the stakeholders review for any
mistakes. Frequently the stakeholders will sign off on it. Then days
later come back with corrections. Proofreading is hard.

What is the proper procedure for doing so?

Any pointers to documents to help with this greatly appreciated.

Oh this is easy just send small PRs and I will read and integrate them.
Thanks in advance because this is important to get better documentation.

I have been a lazy Pharo user for a long time. I always found the Pharo
environment productive and easy to use and never pursued properly
learning to be a good Pharo user. I want to remedy that and work my way
through several of the books. I figure that is a good time to contribute
like this.

I will keep them coming as I work my way through the books.

Good to be a contributing citizen. :)

Jimmie

S

Thanks.

Jimmie

On 1/13/22 06:14, stephane ducasse wrote: >> On 12 Jan 2022, at 02:03, Jimmie Houchin <jlhouchin@gmail.com> wrote: >> >> I am going to be working my way through some Pharo docs. >> >> As I read the books I sometimes see some English that can be improved. > Yes I noticed it too but I’m running too fast and my english is not my native language so > it is not good. Your English is just fine. Probably better than half of Americans. :) But there are probably things that are definitely more noticeable to native English speakers. But it is easy to make mistakes and hard to see your own mistakes. I regularly create documents and then let the stakeholders review for any mistakes. Frequently the stakeholders will sign off on it. Then days later come back with corrections. Proofreading is hard. >> What is the proper procedure for doing so? >> >> Any pointers to documents to help with this greatly appreciated. > Oh this is easy just send small PRs and I will read and integrate them. > Thanks in advance because this is important to get better documentation. I have been a lazy Pharo user for a long time. I always found the Pharo environment productive and easy to use and never pursued properly learning to be a good Pharo user. I want to remedy that and work my way through several of the books. I figure that is a good time to contribute like this. I will keep them coming as I work my way through the books. Good to be a contributing citizen. :) Jimmie > S >> >> Thanks. >> >> >> Jimmie
SD
stephane ducasse
Fri, Jan 14, 2022 1:04 PM

On 1/13/22 06:14, stephane ducasse wrote:

On 12 Jan 2022, at 02:03, Jimmie Houchin <jlhouchin@gmail.com mailto:jlhouchin@gmail.com> wrote:

I am going to be working my way through some Pharo docs.

As I read the books I sometimes see some English that can be improved.

Yes I noticed it too but I’m running too fast and my english is not my native language so
it is not good.

Your English is just fine. Probably better than half of Americans. :)
But there are probably things that are definitely more noticeable to native English speakers.

But it is easy to make mistakes and hard to see your own mistakes. I regularly create documents and then let the stakeholders review for any mistakes. Frequently the stakeholders will sign off on it. Then days later come back with corrections. Proofreading is hard.

Yes now I was reading french documents for a native english with really good french and I often ended rewriting a lot of details.

What is the proper procedure for doing so?

Any pointers to documents to help with this greatly appreciated.

Oh this is easy just send small PRs and I will read and integrate them.
Thanks in advance because this is important to get better documentation.

I have been a lazy Pharo user for a long time. I always found the Pharo environment productive and easy to use and never pursued properly learning to be a good Pharo user. I want to remedy that and work my way through several of the books.

go go go go! Learning is fun.
BTW you should rerun your benches with the new VM since it has some plugins that were missing.

I figure that is a good time to contribute like this.

Oh yes!

I will keep them coming as I work my way through the books.

Good to be a contributing citizen. :)

And you can really have an impact and feel good about it.
Did you read Pharo with Style?
I would like to extend it.
I should review again the Smalltalk with Style book (it is really nice).

> > On 1/13/22 06:14, stephane ducasse wrote: >>> On 12 Jan 2022, at 02:03, Jimmie Houchin <jlhouchin@gmail.com <mailto:jlhouchin@gmail.com>> wrote: >>> >>> I am going to be working my way through some Pharo docs. >>> >>> As I read the books I sometimes see some English that can be improved. >> Yes I noticed it too but I’m running too fast and my english is not my native language so >> it is not good. > > Your English is just fine. Probably better than half of Americans. :) > But there are probably things that are definitely more noticeable to native English speakers. > > > But it is easy to make mistakes and hard to see your own mistakes. I regularly create documents and then let the stakeholders review for any mistakes. Frequently the stakeholders will sign off on it. Then days later come back with corrections. Proofreading is hard. Yes now I was reading french documents for a native english with really good french and I often ended rewriting a lot of details. >>> What is the proper procedure for doing so? >>> >>> Any pointers to documents to help with this greatly appreciated. >> Oh this is easy just send small PRs and I will read and integrate them. >> Thanks in advance because this is important to get better documentation. > > I have been a lazy Pharo user for a long time. I always found the Pharo environment productive and easy to use and never pursued properly learning to be a good Pharo user. I want to remedy that and work my way through several of the books. go go go go! Learning is fun. BTW you should rerun your benches with the new VM since it has some plugins that were missing. > I figure that is a good time to contribute like this. Oh yes! > > I will keep them coming as I work my way through the books. > > Good to be a contributing citizen. :) And you can really have an impact and feel good about it. Did you read Pharo with Style? I would like to extend it. I should review again the Smalltalk with Style book (it is really nice).