Task #9665 (closed)
Opened 12 years ago
Closed 12 years ago
Decided on policy for documentation spelling
Reported by: | sbesson | Owned by: | |
---|---|---|---|
Priority: | blocker | Milestone: | OMERO-4.4.7 |
Component: | Documentation | Version: | n.a. |
Keywords: | n.a. | Cc: | hflynn, jamoore, rkferguson, rleigh, jrswedlow |
Resources: | n.a. | Referenced By: | n.a. |
References: | n.a. | Remaining Time: | n.a. |
Sprint: | 2012-10-23 (1) |
Description
Historical convention of using American spelling has been removed from Sphinx doc policies for 4.4.4.
Due to our inability to make a team decision, the absence of spelling guideline prevents any doc PR to be accepted for 4.5 at this point.
Some aspects that may be taken into account:
- impact of this choice on the audience?
- language of the major contributor(s) to the documentation?
- consistency with API docs (largely using American English)
Change History (3)
comment:1 Changed 12 years ago by jmoore
- Cc jrswedlow added
- Milestone changed from OMERO-Beta4.2 to OMERO-4.5
- Sprint changed from 2010-02-05 (2) to 2012-10-23 (1)
comment:2 Changed 12 years ago by eehill
For info, journals adopt the spelling of the country where their HQ is based:
- PLOS has American English as HQ is in San Francisco, despite their also having a UK office.
- Nature and all Nature journals use British English as their HQ is London (although they also have many other offices globally).
- Note that readership/userbase is not considered with this at all, as they all have global audiences (users)
One other point for consideration might be the funding body's location. I am not sure how much WT/BBSRC would care, but if the money is British...
Just my 2p worth, for whatever value they might still have... (I am actually sorry I will miss this discussion though)
comment:3 Changed 12 years ago by sbesson
- Resolution set to fixed
- Status changed from new to closed
Use American spelling. For more information, see:
http://lists.openmicroscopy.org.uk/mailman/private/ome-nitpick/2012-October/004596.html
I'd agree this should be decided next Tues. Might need some preparation before hand.