Problem/Motivation
Our code documentation should be presented in a professional formal manner. These are not conversations, rather directions/instructions/requirements.
This is especially true for Doxygen.
We must remember that for a great many of our developers English is their second language.
Let's not make this difficult for them.
A quote from everythingenglishblog.com
Now that we know what a contraction is, we must determine when we should avoid them or use them. The answer lies in the formality of the document that you are preparing. If you are engaged in formal writing, I would suggest that you avoid using all contractions. This includes cover letters, résumés, theses, essays, etc. Because the use of contractions seems more informal, you should avoid them in any instance in which you want to portray a professional, respected image.
Emphasis is mine.
I propose we start with the code documentation (Doxygen) and replace all instances of contractions with the full equivalent.
I.E isn't => is not
And so on.
Contractions and plain English
- https://www.plainlanguage.gov/guidelines/conversational/use-contractions/
- https://communicatehealth.com/wehearthealthliteracy/frequently-asked-que...
- https://www.powermapper.com/resources/guides/how-to-write-in-plain-english/
Benefits
If we adopted this change, the Drupal Project would benefit by ...
Three supporters required
- https://www.drupal.org/u/{userid} (yyyy-mm-dd they added support)
- https://www.drupal.org/u/{userid} (yyyy-mm-dd they added support)
- https://www.drupal.org/u/{userid} (yyyy-mm-dd they added support)
Proposed changes
Provide all proposed changes to the Drupal Coding standards. Give a link to each section that will be changed, and show the current text and proposed text as in the following layout:
1. Drupal API documentation standards (general)
Current text
There is no text about contractions
Proposed text
Avoid the use of contractions.
2. Repeat the above for each page or sub-page that needs to be changed.
Remaining tasks
Create this issue in the Coding Standards queue, using the defined template- Add supporters
- Create a Change Record
- Review by the Coding Standards Committee
- Coding Standards Committee takes action as required
- Discussed by the Core Committer Committee, if it impacts Drupal Core
- Final review by Coding Standards Committee
- Documentation updates
- Edit all pages
- Publish change record
- Remove 'Needs documentation edits' tag
- If applicable, create follow-up issues for PHPCS rules/sniffs changes
For a full explanation of these steps see the Coding Standards project page
Comments
Comment #1
cilefen commentedThe official style guidelines do not mention contractions. So this issue is a policy discussion.
From https://www.drupal.org/coding-standards/docs#drupal
Comment #2
mbrett5062 commentedI have read the existing documentation on grammar/style.
I think we need to make a distinction here between formal and informal documentation.
For API and Doxygen I think we should be using a formal style.
Anything else is more of an end user facing manual/directions, these should be informal, inline with current Drupal.org guidelines.
Comment #3
mbrett5062 commentedMaybe I should change the IS to better reflect this?
Comment #4
cilefen commentedSo it may be more of a suggestion of a formal writing style in the code documentation. A title adjustment should do it. If you can think of a better one, please change it.
Comment #5
cilefen commentedMaybe "Adopt a formal writing style in code documentation."
Comment #6
mbrett5062 commentedWill get to this tomorrow. Pool party in 10 minutes :)
Comment #7
jhodgdonThis is a coding standards discussion, so moving to TWG project.
Comment #8
cilefen commentedRe: #5, I think this issue should be about a prose standard for code comments.
Comment #9
cilefen commentedRe: #5, I think this issue should be about a prose standard for code comments.
Comment #10
mbrett5062 commentedUpdated the IS to better reflect that this applies to code and API documentation, not for end users, where we have an informal policy in place to be more welcoming.
Comment #11
tizzo commentedMoving this issue to the Coding Standards queue per the new workflow defined in #2428153: Create and document a process for updating coding standards.
Comment #12
quietone commentedComment #13
quietone commentedComment #14
quietone commentedAdded a suggestion to avoid the use of contractions.
Comment #15
rkollerI am not sure if the categorical avoidance of contractions is the right choice here. First a few additional aspects:
stylesection)it'sorshe'sand some might even understand irregular contractions likelet's(let us). While negative contraction, even the simple ones likecan'tanddon't, can easily be misread by people who are only briefly scanning a text. Their recommendation is, for the sake of clarity, in case the information is in particular important, to spell these out (for example,Do not click Buy before you complete the form). While slangy, outdated, or less usual contractions such asain't,that'll,could've,shan't,'tis, and the unwieldyshouldn't'veshould be avoided in general.The app did not launchcan be more emphatic and clearer thanThe app didn’t launch. In this particular case,notis the most important word in the sentence and you are doing the reader a favor by writing outdid notinstead of condensing it intodidn’t.The three links about contractions and plain english in the issue summary are in the same vein like point 2 and 3.
So as I've state in my initial statement, I would be rather hesitant to ban and remove contractions from the documentation entirely. I would try to still allow the usage of contractions but avoid negative contractions and maybe conditional contractions. And as a rule of thumb in situations where you as the writer want to be empathic and extra clear avoid contractions as well (see point 3). That would be sort of the middle ground between completely banning contractions or using contractions for everything. From my perspective it would improve the general readability but at the same time the copy would become more clear in the situations where it is necessary. And on a side note, personally I also disagree for the given reasons with the strict ban of contractions in the Drupal User Interface Guidelines in point 1.
Comment #16
bbralaGeneral consensus is not to do this, we have had another month of time to see other opinions. Will close this as won't fix.