Change "writeable" to "writable" in documentation

Thanks Goran for patch, I have checked issue in simplytest.me and after applying your patch given typo solved.
PFA Screenshots for the same.

@Jigar.addweb, there is no reason to test a code comment change on simplytest.me, nor to post screenshots of applying a patch. I'm removing the issue credit for this.

This issue also made me do a double-take because "writeable" is actually the spelling I would use. http://www.dictionary.com/browse/writeable gives it as an allowed alternate spelling, my browser does not mark "writeable" as misspelled, and we actually have both in core:

[ibnsina:maintainer | Tue 17:03:42] $ grep -r "writeable" * | grep -v "vendor" | grep -v "node_modules" | wc -l
      22
[ibnsina:maintainer | Tue 17:03:46] $ grep -r "writable" * | grep -v "vendor" | grep -v "node_modules" | wc -l
     154

In fact we even have a method named writeable().

At a minimum, we'd have to adopt one spelling over the other everywhere, but I'm not even sure we need to change it as both spellings are allowed.

Also, we generally expect core to be spellchecked in one go rather than fixing one-off spelling errors. See: #2829185: Fix spelling errors in Drupal core comments

Setting "Needs review" for more discussion.

Patch contains all keyword changes from "writable" to "writeable", in the /Form directory only.

Also, as suggested by @xjm in #9, "writeable" seems apt as it's not regarded as misspelt and is also present in
form of the writeable() method, which seems to suffice for now.

Patch applies cleanly. Changes made are sufficient.

There was no response to the questions in #9

It looks like we decided to go with writeable but there was no dicsussion.

In addition, @xjm asked for this to be part of #2829185: Fix spelling errors in Drupal core comments

I'm not sure the discussion has concluded here yet.

Setting back to needs review

Patch applies cleanly.

The patch applies cleanly without errors. The changes made are sufficient.

@bhanuprakashnani thanks for taking time to apply the patch. However before setting the patch to rtbc all the feedback from the comments needs to be accounted for. In this case especially #15 which points out that consensus on what Drupal should use, writable or writeable, has not been reached. Additionally #9 points out:

At a minimum, we'd have to adopt one spelling over the other everywhere, but I'm not even sure we need to change it as both spellings are allowed.

Wikitonary, dictionary.com and thefreedictionary give both spellings. However, Merriam-Webster has an entry for 'writable' but not 'writeable', which redirects to 'writable'.

Since both are acceptable spellings then lets accept them, and enjoy the freedom of being able to spell a word correctly two different ways. Yet, I can think of one case were having both would be a problem for me and that would be if a comment referred to a method/function named 'writeable' in a comment as 'writable'. Still, there are only 176 instances to check for that, according to the grep in #9.

I'd like to add here that Collins English Dictionary and https://en.oxforddictionaries.com have definitions for 'writable' but not for 'writeable'. Macmillan and Longman do not have definitions for either. 'writable' looks like a better choice to me as it's more widespread. :)

I updated the summary in hopes of get this issue resolved. I think the spelling of writeable/writable is a matter of preference, and I would opt to leave this and every other spelling as-is.

I've tested 2898947-12.patch and it applies cleanly. This patch follows the drupal's coding standards.

My opinion is "writable" word is the correct one to use in all places.

My preference would be for leaving as-is, apart from bad references (writable) to writeable function.

Hi all,

I'm at the newB session at Drupalcon, and I'm going to take a look at this!

Liz

Going with the dictionary spelling (comment #9), here is a patch for using writable throughout core instead of writeable.

This looks good. Seems like you caught every instance of "writeable" in that file.

That looks really bad! Simply not acceptable

Again ignoring what was said and railroading their own opinion. There is no consensus, so no patch should be provided nor reviewed. It is completely irrelevant whether it applies. In addition, failing to understand you simply don't change a public function just because you can!
Also, the patch should NOT change the scope. The issue and discussion is about the use of the word in comments!

Tagging for DrupalNorth 2019

Updated issue summary to clarify what spelling we will be going with.

Update issue title to better reflect the change we decided to make.

Re-roll patch for branch 8.9.x (As of commit 9ef14c6195). No interdiff is necessary because no changes were made.

There are more instances of the word 'writeable' but they are function names and this is a documentation patch, so this can be left as a future issue.

$ grep -r 'writeable' .
./core/tests/Drupal/Tests/Component/PhpStorage/FileStorageReadOnlyTest.php:   * @covers ::writeable
./core/tests/Drupal/Tests/Component/PhpStorage/FileStorageReadOnlyTest.php:    $this->assertFalse($php_read->writeable());
./core/tests/Drupal/Tests/Component/PhpStorage/FileStorageTest.php:   * @covers ::writeable
./core/tests/Drupal/Tests/Component/PhpStorage/FileStorageTest.php:    $this->assertTrue($php->writeable());
./core/includes/install.core.inc:        $requirements["$file file writeable"] = [
./core/lib/Drupal/Component/PhpStorage/PhpStorageInterface.php:  public function writeable();
./core/lib/Drupal/Component/PhpStorage/FileStorage.php:  public function writeable() {
./core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php:  public function writeable() {

hii @jordanwood

I have recreated a patch with the suggestions for more files with spelling replacement from writeable to writable.
Please review.

@shimpy, thank you for the patch; but changing the function names changes Drupal's API, and I believe that is beyond the scope of this novice documentation task.

Changing Drupal's API is a backwards compatibility break, because doing so would break existing contributed and custom modules written for Drupal 8 which relied on the functions that were renamed.

I was working with @jordanwood on the patch he posted in #41; and I suggested that he post the message in #42 to help reviewers understand why grepping Drupal core for "writeable" would still return results; so I take responsibility for the confusion.

Clarified scope in the issue summary.

hii @mparker17
Thanks for clearifying the issue summary. It will better help reviewers to review the patch now.

I have tested patch #41 by grepping. Except the functions the writeabe word is replaced by writable. Attaching the screenshot for same as well. This patch works for me.

I think a cURL error might be testbot having a bad day... going to set this back to "RTBC" and see if it just starts working again.

We can file a followup for the method names -- we'd create new versions spelled writable, make the old versions wrappers of the new ones, and then deprecate the old ones.

#40 also does not apply to 9.1.x. So, we need a 9.1.x version of #40 (which will probably also work for 9.0.x). For clarity, we can also re-upload #40 in the same comment as the 8.9.x version of the patch (since there was an invalid patch between that one and here). Thanks!

However, since this is eligible for commit to all four branches as a docs fix, filing against 8.8.x. (You can test the patches against other branches when you upload them by setting the "Test with" select field next to the upload button.)

(As an aside, in my head, I read "writable" as "writ-able", like, you could provide a writ for it? 😂But it is indeed a correct spelling, and more common that "writeable" in our codebase, plus PHP natively has is_writable(), so that's probably preferred.)

Scope creep. For BC reasons don't change function names, not even in 9.1.

#57 looks good to me. successfully applied and change the writeable to writable wherever neccesary except the functions call

Moving back to 8.8.x; see #53. If necessary we can create separate patches for separate branches and choose the branch to test with when they're uploaded.

@Lal_, when you create patches, please provide an interdiff so we can review your changes. Also please read the issue more carefully as we already made it clear that only documentation should be changed.

+++ b/core/includes/install.core.inc
@@ -2189,7 +2189,7 @@ function install_check_requirements($install_state) {
-        $requirements["$file file writeable"] = [
+        $requirements["$file file writable"] = [

This is an internal API change and should be reverted.

We also still need that followup to deprecate "writeable" methods and change the test methods.

I'll have to take a close look at the patches in this issue when determining credit, as there have been a number of patches that did not take into account the instructions of the issue and that just repeated the work of others. It's very important to read the issue and comments before creating a patch, and to build on the work of other contributors rather than just starting over with your own version.

Thanks for your work contributing to core!

Hi @xjm as per your suggestion. I have created the interdiff aas well as removed that section which you were pointing out to be changed.

Patch does not apply.

Please review this patch as #60 failed to apply.

#63 Patch Applied. Looks good to me.

Thanks

I'd postpone this on #2972224: Add .cspell.json to automate spellchecking in Drupal core, but leave the status untouched, what if someone unhappy with this :)

All the changes in the patch look good. I still find 1 occurrence in the file: "core/tests/Drupal/FunctionalJavascriptTests/WebDriverTestBase.php"
There is still a followup issue to be created.

Unable to find "writeable" word in the "core/tests/Drupal/FunctionalJavascriptTests/WebDriverTestBase.php" file.

As well as there's no "writeable" word left in the CORE.

@ankit.singh: You are right. In 8.8 there is no occurrence of the word "writeable". In 9.0 and 9.1 there is an occurrence. See: https://git.drupalcode.org/project/drupal/-/blob/9.1.x/core/tests/Drupal.... As a result of that difference there need to be 2 patches: one for 8.x and one for 9.x.

Hi @daffie,

I have created the patch for 9.x and search "writeable" in the core, now there's no occurrence of "writeable" except the functions call.

The followup that @xjm is asking for in comment #59 still needs to be done.

I think #59 issue is resolved in patch #63 for version 8.8 and I did the same in patch #70 for version 9.x

The 2 patches from comments #63 and #70 are together for me RTBC.
The by @xjm requested followup still needs to be created. After that is done, is it for me RTBC.

Successfully applied both the patch from #63 and #70.

Regarding #63: "writeable" is replaced from almost everywhere but I think there is still one "writeable" word left in core/modules/simpletest/src/KernelTestBase.php file.

Regarding #70: Patch looks good to me. No occurrence of "writeable" word in the core documentation.

Fixed remaining outstanding instance mentioned in #74.

The by @xjm requested followup still needs to be created.

Created followup issue as requested by xjm in #59: #3138595: Deprecate PhpStorage ::writeable() methods for removal in Drupal 11 with no replacement

All occurrences of "writeable" in comments have been changed.
Did a code search for all for current branches of core.
All code changes in both patches look good.
The requested followup is created.
For me it is RTBC.

Adding this as a child issue of #3122088: [Meta] Remove spelling errors from dictionary.txt and fix them and it's postponed on #2972224: Add .cspell.json to automate spellchecking in Drupal core right now.

Once #2972224: Add .cspell.json to automate spellchecking in Drupal core is in we can add writeable to the flag words and fix this once and for all.

Applied patch. All occurrences of "writeable" in comments are changed. Kindly review

@Swapnil_Kotwal Please add the interdiff it's very helpful for reviewer to identify what new changes added in patch.

The last submitted patch 2898947-77.patch is not applicable for 8.9.x (and 9.1.x as well). Need to check, I am working on it.

After reading all the comments, I have come with two versions of patches as per the comment number of #9, #31, #40, #41, #52 and then #53

2898947-86--writeable-to-writable-8.9.x => applied successfully for both 8.8.x and 8.9.x

2898947-86--writeable-to-writable-9.1.x => applied successfully for both 9.0.x and 9.1.x

And an important point to note, this is the changes from writeable to writable of core excluding the 3 core function name as mentioned in the scope

Thanks
Rajandro

Expected test case failure due to change on * @covers ::writeable, Now adding the patch without that two changes.

Thanks
Rajandro

Moving this to NR with the interdiff of #86 and #87, Please review it.

Thanks
Rajandro

$ grep -ri writeable core composer --exclude-dir=core/node_modules
core/tests/Drupal/Tests/Component/PhpStorage/FileStorageReadOnlyTest.php:   * @covers ::writeable
core/tests/Drupal/Tests/Component/PhpStorage/FileStorageReadOnlyTest.php:  public function testWriteable() {
core/tests/Drupal/Tests/Component/PhpStorage/FileStorageReadOnlyTest.php:    $this->assertFalse($php_read->writeable());
core/tests/Drupal/Tests/Component/PhpStorage/FileStorageTest.php:   * @covers ::writeable
core/tests/Drupal/Tests/Component/PhpStorage/FileStorageTest.php:  public function testWriteable() {
core/tests/Drupal/Tests/Component/PhpStorage/FileStorageTest.php:    $this->assertTrue($php->writeable());
core/includes/install.core.inc:        $requirements["$file file writeable"] = [
core/lib/Drupal/Component/PhpStorage/PhpStorageInterface.php:  public function writeable();
core/lib/Drupal/Component/PhpStorage/FileStorage.php:  public function writeable() {
core/lib/Drupal/Component/PhpStorage/FileReadOnlyStorage.php:  public function writeable() {

1. $requirements["$file file writeable"] should not be changed per @xjm's comment in #59
2. writeable in the Component should be done in a follow-up per @xjm's comment in #59, tagging "Needs followup"
3. The core/misc/cspell/dictionary.txt should be updated. As this is a tiny change, i will upload a new patch for 9.1.x and setting to RTBC.
4. The patch in #87 for 8.9.x is still valid. The 9.1.x patch in #87 should be valid for 9.0.x, i will re-queue it, or provide a new one if it fails.

Changing the target branch to 9.1.x

Filed a follow-up #3155345: Change "writeable" in PhpStorage component to "writable"

Q: How to proper changing writeable in $requirements["$file file writeable"] to writable?

@jungle I don't understand why the dictionary is being updated here. We can add writeable to the flagwords because we've nt removed it. That's something that'll only be possible in Drupal 10. If you feel #87 is rtbc without the dictionary change can you re-upload that one so that it is the latest patch on the issue.

Re #92

1. +++ b/core/misc/cspell/dictionary.txt
   @@ -560,7 +560,6 @@ elit
   -emtity
   
   @@ -972,7 +971,6 @@ linkback
   -linktitle
   

   After running “spellcheck:make-drupal-dict” to check typos and to re-generate the dictionary at the same time as you can see that two words are removed. I have n't touched "writeable"/"writable" here. This is why I updated the dictionary. If you think the change is unnecessary still, I will re-upload the patch in #87.

2. As writeable still exists in the codebase, not sure if we should add it into flagwords here

Thanks!

Well, re-uploading the patches in #87, the change to the directory in #89 is out of scope here.

We also need a follow-up for changing $requirements["$file file writeable"] - as a render array this can change in a minor but needs it's own issue and maybe a CR. I created #3155400: Change $requirements["$file file writeable"] to $requirements["$file file writable"]

@codersukanta thanks for applying the patch and searching the code base. In these instances screenshots are not that helpful and look more like an attempt to game issue credit. An alternative approach would have been to provide an interdif.

I've tried to credit everyone who made conttributions to the discussions and helped manage the issue towards a reasonable scope and conclusion.

Committed and pushed a0a8601936 to 9.1.x and d2734732e7 to 9.0.x. Thanks!
Committed 9e9e25b770 and pushed to 8.9.x. Thanks!

Backported to 8.9.x and 9.0.x since this is only changing documentation.