Recent

Author Topic: Documentation Questions  (Read 2584 times)

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Documentation Questions
« on: February 24, 2019, 04:12:55 am »
I recently started updating documentation files for LCL and LazUtils. One of the things I wanted to do was fix some of the spelling errors. So I now have 54 updated files with spelling errors corrected.

In the process, I wound up not so inadvertently removing almost all use of the word colour. It seemed wrong to describe properties with the word Color in them using the other British variant. I realize that's how most of the English-speaking world spells it.

After seeing the extent of the changes, I figured I should at least ask before submitting such a drastic patch. Actually, I should have asked before I started making my changes. It's not a vendetta against British English. Honest. All the other differences are still intact; behaviour, flavour, minimalised, maximised, initialised, etc. And StyleGuide.txt doesn't address this particular issue.

I didn't want to tick anyone off. Seeking advice...

Don
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

Handoko

  • Hero Member
  • *****
  • Posts: 5130
  • My goal: build my own game engine using Lazarus
Re: Documentation Questions
« Reply #1 on: February 24, 2019, 04:29:01 am »
I recently started updating documentation files for LCL and LazUtils.

That's great.
Thank you for making the documentation better.

About the language variants, I have no problem. But as I heard American English is most widely used (58%):
http://www.todby.com/2016/02/american-english-vs-british-english.html
« Last Edit: February 24, 2019, 04:31:40 am by Handoko »

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Re: Documentation Questions
« Reply #2 on: February 24, 2019, 05:54:11 am »
I recently started updating documentation files for LCL and LazUtils.

That's great.
Thank you for making the documentation better.

About the language variants, I have no problem. But as I heard American English is most widely used (58%):
http://www.todby.com/2016/02/american-english-vs-british-english.html

Thanks for that. I thought the spelling issues would be "low hanging fruit". Apparently the fruit has worms.  :D
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

JuhaManninen

  • Global Moderator
  • Hero Member
  • *****
  • Posts: 4459
  • I like bugs.
Re: Documentation Questions
« Reply #3 on: February 24, 2019, 07:46:12 am »
Yes, American English is mainly used in the documentation. I think spelling "color" is already used in most places.
For the sake of consistency all spelling can be changed to the American variant.
Mostly Lazarus trunk and FPC 3.2 on Manjaro Linux 64-bit.

marcov

  • Administrator
  • Hero Member
  • *
  • Posts: 11383
  • FPC developer.
Re: Documentation Questions
« Reply #4 on: February 24, 2019, 03:09:29 pm »
Lazarus and FPC are products that mimic American products, but most old core members were Europeans, and probably got taught British English in school.

That said, I'm hopelessly inconsistent myself.

dsiders

  • Hero Member
  • *****
  • Posts: 1052
Re: Documentation Questions
« Reply #5 on: February 24, 2019, 08:36:58 pm »
Yes, American English is mainly used in the documentation. I think spelling "color" is already used in most places.
For the sake of consistency all spelling can be changed to the American variant.

OK. Thanks.

Expect a patch for LCL soon. I may hold off on LazUtils and files in the FpDocs tree until I see if there is any unexpected blowback from this.
Preview Lazarus 3.99 documentation at: https://dsiders.gitlab.io/lazdocsnext

 

TinyPortal © 2005-2018