[GitHub] mesos pull request #256: Correct spelling errors in the docs

[pleia2]

Github user pleia2 closed the pull request at:

https://github.com/apache/mesos/pull/256


---

[GitHub] mesos pull request #256: Correct spelling errors in the docs

[pleia2]

Github user pleia2 commented on a diff in the pull request:

https://github.com/apache/mesos/pull/256#discussion_r161921933
  
--- Diff: docs/app-framework-development-guide.md ---
@@ -91,13 +91,13 @@ virtual void offerRescinded(SchedulerDriver* driver, 
const OfferID& offerId);
  * Invoked when the status of a task has changed (e.g., a slave is
  * lost and so the task is lost, a task finishes and an executor
  * sends a status update saying so, etc). If implicit
- * acknowledgements are being used, then returning from this
+ * acknowledgments are being used, then returning from this
--- End diff --

Ok, I'll back out these adjustments.


---

[GitHub] mesos pull request #256: Correct spelling errors in the docs

[pleia2]

Github user pleia2 commented on a diff in the pull request:

https://github.com/apache/mesos/pull/256#discussion_r161922006
  
--- Diff: docs/endpoints/files/browse.json.md ---
@@ -20,7 +20,7 @@ Query parameters:
 
 
 ### AUTHENTICATION ###
-This endpoint requires authentication iff HTTP authentication is
+This endpoint requires authentication if HTTP authentication is
--- End diff --

Noted, I wasn't familiar with this short form. I'll remove these edits.


---

[GitHub] mesos pull request #256: Correct spelling errors in the docs

[bbannier]

Github user bbannier commented on a diff in the pull request:

https://github.com/apache/mesos/pull/256#discussion_r161343683
  
--- Diff: docs/endpoints/files/browse.json.md ---
@@ -20,7 +20,7 @@ Query parameters:
 
 
 ### AUTHENTICATION ###
-This endpoint requires authentication iff HTTP authentication is
+This endpoint requires authentication if HTTP authentication is
--- End diff --

I created to track removal of these files; the fix is in principal trivial, 
we just need to make sure to not break existing tooling.

Regarding this change, I was educated by a native speaker that the spelling 
here is actually valid and intended when I tried to perform a similar change, 
https://reviews.apache.org/r/46934/.


---

[GitHub] mesos pull request #256: Correct spelling errors in the docs

[bmahler]

Github user bmahler commented on a diff in the pull request:

https://github.com/apache/mesos/pull/256#discussion_r161337083
  
--- Diff: docs/endpoints/files/browse.json.md ---
@@ -20,7 +20,7 @@ Query parameters:
 
 
 ### AUTHENTICATION ###
-This endpoint requires authentication iff HTTP authentication is
+This endpoint requires authentication if HTTP authentication is
--- End diff --

Sure, however this file is actually generated from source, so the change 
would need to be made there:
https://github.com/apache/mesos/blob/1.4.0/src/files/files.cpp#L352-L371

https://github.com/apache/mesos/blob/1.4.0/3rdparty/libprocess/include/process/help.hpp#L82-L90

I think @bbannier was looking into whether we could remove generated 
markdown since they're no longer needed. We now generate them at the time of 
publishing the website.


---

[GitHub] mesos pull request #256: Correct spelling errors in the docs

[ralic]

Github user ralic commented on a diff in the pull request:

https://github.com/apache/mesos/pull/256#discussion_r161336318
  
--- Diff: docs/endpoints/files/browse.json.md ---
@@ -20,7 +20,7 @@ Query parameters:
 
 
 ### AUTHENTICATION ###
-This endpoint requires authentication iff HTTP authentication is
+This endpoint requires authentication if HTTP authentication is
--- End diff --

Since it is documentation, would it be better not to use acronym ? So that 
translation of the documentation maybe access by machine or the reader easier.


---

[GitHub] mesos pull request #256: Correct spelling errors in the docs

[bmahler]

Github user bmahler commented on a diff in the pull request:

https://github.com/apache/mesos/pull/256#discussion_r161334491
  
--- Diff: docs/endpoints/files/browse.json.md ---
@@ -20,7 +20,7 @@ Query parameters:
 
 
 ### AUTHENTICATION ###
-This endpoint requires authentication iff HTTP authentication is
+This endpoint requires authentication if HTTP authentication is
--- End diff --

We should leave as 'iff' since this is a short form of "if and only if". 
Ditto on the other cases.


---

[GitHub] mesos pull request #256: Correct spelling errors in the docs

[bmahler]

Github user bmahler commented on a diff in the pull request:

https://github.com/apache/mesos/pull/256#discussion_r161334849
  
--- Diff: docs/app-framework-development-guide.md ---
@@ -91,13 +91,13 @@ virtual void offerRescinded(SchedulerDriver* driver, 
const OfferID& offerId);
  * Invoked when the status of a task has changed (e.g., a slave is
  * lost and so the task is lost, a task finishes and an executor
  * sends a status update saying so, etc). If implicit
- * acknowledgements are being used, then returning from this
+ * acknowledgments are being used, then returning from this
--- End diff --

I'm inclined to leave in the extra "e" since I believe both spellings are 
acceptable FWICT and we have more with the extra "e":

➜  mesos git:(master) ✗ grep -Ri acknowledgements src | wc -l
 149
➜  mesos git:(master) ✗ grep -Ri acknowledgments src | wc -l
   6

Ditto for the other cases.


---

[GitHub] mesos pull request #256: Correct spelling errors in the docs

[pleia2]

GitHub user pleia2 opened a pull request:

https://github.com/apache/mesos/pull/256

Correct spelling errors in the docs



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/pleia2/mesos pleia2/spellcheck

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/mesos/pull/256.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #256


commit b12a8d7e49faf973557029e1a19edbca7ed77d27
Author: Elizabeth K. Joseph 
Date:   2018-01-11T23:53:44Z

Remove missing MUGs from site

The Beijing, Sevilla, Albany and Austin MUGs no longer exist on
Meetup, removing.

commit 90ea630ff19572afbc63f7734390222dd5efdc34
Author: Elizabeth K. Joseph 
Date:   2018-01-12T01:54:43Z

Correct spelling errors in the docs




---