"Children" not "childs"

Bug #327259 reported by Numérigraphe
2
Affects Status Importance Assigned to Milestone
Odoo Addons (MOVED TO GITHUB)
Opinion
Wishlist
OpenERP R&D Addons Team 1
Nominated for Trunk by Numérigraphe
Odoo Server (MOVED TO GITHUB)
Fix Released
Wishlist
OpenERP's Framework R&D
Nominated for Trunk by Numérigraphe
Odoo Web Client
Fix Released
Wishlist
OpenERP R&D Web Team
Trunk
Fix Released
Wishlist
OpenERP R&D Web Team

Bug Description

English is not my mother tongue, so forgive me if I'm wrong, but : very often on OpenERP we see "childs" written instead of "children" and that's wrong.
You can find field names, in help texts, and in the documentation.

One problem with that is that our English/American users surely won't find it professional looking.

Initially this bug also mentioned spelling errors in the code but now that's Bug #673087.

Tags: wording

Related branches

Revision history for this message
Raphaël Valyi - http://www.akretion.com (rvalyi) wrote :

Hi,

definitely related to issues like this one:
https://bugs.launchpad.net/openobject-addons/+bug/326160

Not a top priority, but when the mistake is lying at the database schema, it will be tough to migrate smoothly. I think this is to be fixed for broader international penetration, but IMHO Tiny should correct this ONLY after he successfully set up a communication channel to communicate about API/schema changes where partners/community can attach migration scripts to help everyone pay attention to those changes and streamline the migration.

Revision history for this message
Numérigraphe (numerigraphe) wrote :

This is not a duplicate of bug #326160.

Changed in openobject-addons:
status: New → Confirmed
Changed in openobject-server:
status: New → Fix Committed
Changed in openobject-client-web:
status: New → Fix Committed
Changed in openobject-addons:
status: Confirmed → Fix Committed
Revision history for this message
Numérigraphe (numerigraphe) wrote :

I committed a fix for the trunk extra-addons too - I did my best to not change any field name so as not to force migration.
Lionel

Revision history for this message
Jay Vora (Serpent Consulting Services) (jayvora) wrote :

Thank you for the work Lionel.
We will plan to get it solved soon.

Changed in openobject-addons:
assignee: nobody → JMA(Open ERP) (jma-openerp)
milestone: none → 5.2
Revision history for this message
Numérigraphe (numerigraphe) wrote : Re: [Bug 327259] Re: "Children" not "childs"

Fine, please let me know when is the best moment for this sort of
changes, so I can sync our "-wording" branches and submit them for merging.
I did my best to keep them clean so don't hesitate to cherry-pick
revisions in them if you want.
Lionel

Changed in openobject-addons:
assignee: JMA(Open ERP) (jma-openerp) → nobody
Changed in openobject-addons:
importance: Undecided → Wishlist
Changed in openobject-server:
importance: Undecided → Wishlist
Changed in openobject-client-web:
importance: Undecided → Wishlist
Changed in openobject-addons:
status: Fix Committed → Confirmed
Changed in openobject-server:
status: Fix Committed → Confirmed
Changed in openobject-client-web:
status: Fix Committed → Confirmed
Revision history for this message
Antony Lesuisse (OpenERP) (al-openerp) wrote :

Only user visible occurences (like in help texts) should be changed.
Renaming var names should only happen if the code is actually refactored.

Changed in openobject-addons:
assignee: nobody → OpenERP R&D Addons Team 1 (openerp-dev-addons1)
Changed in openobject-client-web:
assignee: nobody → OpenERP SA's Web Client R&D (openerp-dev-web)
Changed in openobject-server:
assignee: nobody → OpenERP's Framework R&D (openerp-dev-framework)
Revision history for this message
Christophe Simonis (OpenERP) (kangol) wrote :

same for "datas" instead of "data"

Revision history for this message
xrg (xrg) wrote :

On Monday 08 November 2010, you wrote:
> same for "datas" instead of "data"

IMHO, spell-checking the code makes no sense. Variable names are arbitrary,
they needn't follow any language rules [1].
So, "datas" is correct, "dataass" is also correct. I know even more names[2]
that would be lousy English. So what?

On the other hand, renaming variables just for the sake of English
correctness, may introduce real bugs in modules that reference those names.
What if the "datas" column is not properly migrated to the "data" one?

Surely, when a _new_ module or piece of code is introduced, we'd better try to
have sensible names for the _new_ variables.

[1] except that they must not be confusing and fit in a single 15'' monitor, no
Java ones, please!
[2] yes, including the "ressource" one

tfr (Openerp) (tfr)
Changed in openobject-addons:
milestone: 6.0 → none
Revision history for this message
Numérigraphe (numerigraphe) wrote :

Splitting this bug in two : user stings here, code in Bug #673087.

description: updated
Revision history for this message
Geoff Gardiner (geoff-gardiner) wrote : Re: [Openerp-expert-localization] [Bug 327259] Re: "Children" not "childs"

2010/11/9 Numérigraphe <email address hidden>

> ... it may seem strange to refactor only to fix typos but ...
>

We've been through this before, but I should mention it again:

About 2 years ago I corrected much of the English for Open ERP (I changed
only the label strings, not the names). Since then, new strings have been
put in with the same old incorrect spellings (there are some favourites,
which must be rooted in one language or another - *developper* is one, *
ressource* is another). So a one-off change does not work for long.

Somebody proposed a new process so that incorrect spelling does not get
committed to the published code, but I don't think that process has been
implemented.

There are significant differences between UK English and American English,
but most UK people are used to seeing that. Accountants are more resistant:
they like to see 'Creditors' rather than 'Accounts Payable' for example, so
there should be an easy way to provide differences - which there is in
OpenERP.

Regards, Geoff

Revision history for this message
Antony Lesuisse (OpenERP) (al-openerp) wrote :

@xrg, @Geoff Gardiner, That is exactly the policy i want enforce:

- User exposed strings MUST be correct english.
- Variables names are just symbols used by programmers and we wont rename them for the sake of it
- But, if we refactor some part of the code or introduce new code we SHOULD use nice and correctly named variables and it is allowed to rename stupid varnames.

Revision history for this message
Raphaël Valyi - http://www.akretion.com (rvalyi) wrote : Re: [Bug 327259] Re: "Children" not "childs"

@Antony, @xrg

"if we refactor some part of the code or introduce new code we SHOULD use
nice and correctly named variables"
-> Well, you might still have a chance to avoid creating yet a new typo /
bad concept for all your future v6 customers that will use your new v6
project_long_term module:
https://bugs.launchpad.net/openobject-addons/+bug/625428

I hope OpenERP SA is aware how important it is to put it all on new release
to avoid introducing new typos that would drag development for years if
missed.

I also emphasis this is very important to have correct English and
conventions in your code on the contrary: don't neglect the seduction factor
(or on the contrary repulsion) your code can have with your developers
community. You are trying to develop in the US, right? How will US engineers
react when they will read childs or datas? Well chances are they would run
away and stick with frameworks that look more appealing on the surface. Look
at the Ruby on Rails success (not a small thing, it's slowly taking over all
the J2EE stack), well a large part of the success is due to the high quality
of the framework + excellent conventions (including naming ones) that
seduced a large community of advanced developers. History also tells us that
many excellent European open source softwares also failed to become
mainstream due to poor English.

2010/11/11 Antony Lesuisse <email address hidden>

> @xrg, @Geoff Gardiner, That is exactly the policy i want enforce:
>
> - User exposed strings MUST be correct english.
> - Variables names are just symbols used by programmers and we wont rename
> them for the sake of it
> - But, if we refactor some part of the code or introduce new code we SHOULD
> use nice and correctly named variables and it is allowed to rename stupid
> varnames.
>
> --
> "Children" not "childs"
> https://bugs.launchpad.net/bugs/327259
> You received this bug notification because you are subscribed to
> OpenObject Addons.
>
> Status in OpenObject Addons Modules: Confirmed
> Status in OpenObject Web Client: Confirmed
> Status in OpenObject Server: Confirmed
>
> Bug description:
> English is not my mother tongue, so forgive me if I'm wrong, but : very
> often on OpenERP we see "childs" written instead of "children" and that's
> wrong.
> You can find field names, in help texts, and in the documentation.
>
> One problem with that is that our English/American users surely won't find
> it professional looking.
>
> Initially this bug also mentioned spelling errors in the code but now
> that's Bug #673087.
>
>
>
>
>

Revision history for this message
Geoff Gardiner (geoff-gardiner) wrote : Re: [Openerp-expert-localization] [Bug 327259] Re: "Children" not "childs"

@Raphaël,

If OpenERP SA were aware how important it is, they would help run a process
that prevents new errors from being made. I have lost touch with the
introduction process, but it sounds like new errors are still getting
through.

2010/11/11 Raphaël Valyi - http://www.akretion.com <
<email address hidden>>

> ... I hope OpenERP SA is aware how important it is to put it all on new
> release
> to avoid introducing new typos that would drag development for years if
> missed. ...
>

Revision history for this message
Xavier (Open ERP) (xmo-deactivatedaccount) wrote :

marking branch as merged for web client as it was done a while ago.

Changed in openobject-client-web:
status: Confirmed → Fix Released
Changed in openobject-server:
status: Confirmed → Fix Released
Revision history for this message
Ferdinand (office-chricar) wrote :

such "transformations" of connotation complicate things a bit ....
see https://bugs.launchpad.net/openobject-addons/+bug/656163
in sale.py
        'invoiced': fields.function(_invoiced, method=True, string='Paid',
            fnct_search=_invoiced_search, type='boolean', help="It indicates that an invoice has been paid"),

Revision history for this message
Borja López Soilán (NeoPolus) (borjals) wrote :

On 2010-11-11 10:46, Geoff Gardiner wrote:
> 2010/11/9 Numérigraphe <<email address hidden>
> <mailto:<email address hidden>>>
>
> ... it may seem strange to refactor only to fix typos but ...
>
>
> We've been through this before, but I should mention it again:
>
> About 2 years ago I corrected much of the English for Open ERP (I
> changed only the label strings, not the names). Since then, new
> strings have been put in with the same old incorrect spellings (there
> are some favourites, which must be rooted in one language or another -
> /developper/ is one, /ressource/ is another). So a one-off change does
> not work for long.
>
> Somebody proposed a new process so that incorrect spelling does not
> get committed to the published code, but I don't think that process
> has been implemented.

Maybe they should implement it on the integration server
(http://test.openobject.com/).
Making a Ruby or Python script that checks for common mistakes
("childs", "developper") does not look to hard. The server could then
send those "spelling warnings" to the commiters, just as it does now
when a commit does not pass the unit/integration tests.

--
Borja López Soilán
<email address hidden>

Revision history for this message
Geoff Gardiner (geoff-gardiner) wrote :

On 12 November 2010 11:06, Borja LS <email address hidden> wrote:

> ...
> Maybe they should implement it on the integration server (
> http://test.openobject.com/).
> Making a Ruby or Python script that checks for common mistakes ("childs",
> "developper") does not look to hard. The server could then send those
> "spelling warnings" to the commiters, just as it does now when a commit does
> not pass the unit/integration tests.
>

That would be quite good - automate what you can, allow approved people to
add strings that throw up a warning.

We would still need a native speaker of English or American to be the final
judge when it is difficult as Ferdinand points out.

Geoff

tags: added: wording
tfr (Openerp) (tfr)
Changed in openobject-addons:
status: Confirmed → Opinion
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.