You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mesos.apache.org by pleia2 <gi...@git.apache.org> on 2018/01/12 02:00:20 UTC
[GitHub] mesos pull request #256: Correct spelling errors in the docs
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 <ly...@...>
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 <ly...@...>
Date: 2018-01-12T01:54:43Z
Correct spelling errors in the docs
----
---
[GitHub] mesos pull request #256: Correct spelling errors in the docs
Posted by bmahler <gi...@git.apache.org>.
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
Posted by bmahler <gi...@git.apache.org>.
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 issue #256: Correct spelling errors in the docs
Posted by bmahler <gi...@git.apache.org>.
Github user bmahler commented on the issue:
https://github.com/apache/mesos/pull/256
Hm.. I'm unable to pull the patch down:
```
$ ./support/apply-reviews.py -g 256
Cookie coming from patch-diff.githubusercontent.com attempted to set domain to github.com
2018-01-30 14:41:09 URL:https://patch-diff.githubusercontent.com/raw/apache/mesos/pull/256.patch [96588] -> "256.patch" [1]
error: patch failed: site/source/community/user-groups.html.md:10
error: site/source/community/user-groups.html.md: patch does not apply
error: patch failed: docs/advanced-contribution.md:23
error: docs/advanced-contribution.md: patch does not apply
error: patch failed: docs/app-framework-development-guide.md:91
error: docs/app-framework-development-guide.md: patch does not apply
error: patch failed: docs/building.md:90
error: docs/building.md: patch does not apply
error: patch failed: docs/cmake.md:106
error: docs/cmake.md: patch does not apply
error: patch failed: docs/cni.md:202
error: docs/cni.md: patch does not apply
error: patch failed: docs/committing.md:24
error: docs/committing.md: patch does not apply
error: patch failed: docs/configuration/cmake.md:146
error: docs/configuration/cmake.md: patch does not apply
error: patch failed: docs/containerizers.md:38
error: docs/containerizers.md: patch does not apply
error: patch failed: docs/csi.md:177
error: docs/csi.md: patch does not apply
error: patch failed: docs/doxygen-style-guide.md:67
error: docs/doxygen-style-guide.md: patch does not apply
error: patch failed: docs/endpoints/files/browse.json.md:20
error: docs/endpoints/files/browse.json.md: patch does not apply
error: patch failed: docs/endpoints/files/browse.md:20
error: docs/endpoints/files/browse.md: patch does not apply
error: patch failed: docs/endpoints/files/debug.json.md:16
error: docs/endpoints/files/debug.json.md: patch does not apply
error: patch failed: docs/endpoints/files/debug.md:16
error: docs/endpoints/files/debug.md: patch does not apply
error: patch failed: docs/endpoints/files/download.json.md:20
error: docs/endpoints/files/download.json.md: patch does not apply
error: patch failed: docs/endpoints/files/download.md:20
error: docs/endpoints/files/download.md: patch does not apply
error: patch failed: docs/endpoints/files/read.json.md:21
error: docs/endpoints/files/read.json.md: patch does not apply
error: patch failed: docs/endpoints/files/read.md:21
error: docs/endpoints/files/read.md: patch does not apply
error: patch failed: docs/endpoints/master/create-volumes.md:31
error: docs/endpoints/master/create-volumes.md: patch does not apply
error: patch failed: docs/endpoints/master/destroy-volumes.md:31
error: docs/endpoints/master/destroy-volumes.md: patch does not apply
error: patch failed: docs/endpoints/master/flags.md:12
error: docs/endpoints/master/flags.md: patch does not apply
error: patch failed: docs/endpoints/master/frameworks.md:25
error: docs/endpoints/master/frameworks.md: patch does not apply
error: patch failed: docs/endpoints/master/health.md:12
error: docs/endpoints/master/health.md: patch does not apply
error: patch failed: docs/endpoints/master/quota.md:30
error: docs/endpoints/master/quota.md: patch does not apply
error: patch failed: docs/endpoints/master/reserve.md:31
error: docs/endpoints/master/reserve.md: patch does not apply
error: patch failed: docs/endpoints/master/roles.json.md:28
error: docs/endpoints/master/roles.json.md: patch does not apply
error: patch failed: docs/endpoints/master/roles.md:28
error: docs/endpoints/master/roles.md: patch does not apply
error: patch failed: docs/endpoints/master/slaves.md:29
error: docs/endpoints/master/slaves.md: patch does not apply
error: patch failed: docs/endpoints/master/state-summary.md:28
error: docs/endpoints/master/state-summary.md: patch does not apply
error: patch failed: docs/endpoints/master/state.md:97
error: docs/endpoints/master/state.md: patch does not apply
error: patch failed: docs/endpoints/master/tasks.json.md:34
error: docs/endpoints/master/tasks.json.md: patch does not apply
error: patch failed: docs/endpoints/master/tasks.md:34
error: docs/endpoints/master/tasks.md: patch does not apply
error: patch failed: docs/endpoints/master/teardown.md:25
error: docs/endpoints/master/teardown.md: patch does not apply
error: patch failed: docs/endpoints/master/unreserve.md:31
error: docs/endpoints/master/unreserve.md: patch does not apply
error: patch failed: docs/endpoints/master/weights.md:25
error: docs/endpoints/master/weights.md: patch does not apply
error: patch failed: docs/endpoints/metrics/snapshot.md:22
error: docs/endpoints/metrics/snapshot.md: patch does not apply
error: patch failed: docs/endpoints/profiler/start.md:15
error: docs/endpoints/profiler/start.md: patch does not apply
error: patch failed: docs/endpoints/profiler/stop.md:15
error: docs/endpoints/profiler/stop.md: patch does not apply
error: patch failed: docs/endpoints/registrar/registry.md:59
error: docs/endpoints/registrar/registry.md: patch does not apply
error: patch failed: docs/endpoints/slave/containers.md:49
error: docs/endpoints/slave/containers.md: patch does not apply
error: patch failed: docs/endpoints/slave/flags.md:12
error: docs/endpoints/slave/flags.md: patch does not apply
error: patch failed: docs/endpoints/slave/health.md:12
error: docs/endpoints/slave/health.md: patch does not apply
error: patch failed: docs/endpoints/slave/state.json.md:103
error: docs/endpoints/slave/state.json.md: patch does not apply
error: patch failed: docs/endpoints/slave/state.md:103
error: docs/endpoints/slave/state.md: patch does not apply
error: patch failed: docs/fetcher-cache-internals.md:65
error: docs/fetcher-cache-internals.md: patch does not apply
error: patch failed: docs/fetcher.md:18
error: docs/fetcher.md: patch does not apply
error: patch failed: docs/health-checks.md:211
error: docs/health-checks.md: patch does not apply
error: patch failed: docs/isolators/filesystem-shared.md:10
error: docs/isolators/filesystem-shared.md: patch does not apply
error: patch failed: docs/isolators/network-ports.md:49
error: docs/isolators/network-ports.md: patch does not apply
error: patch failed: docs/multiple-disk.md:22
error: docs/multiple-disk.md: patch does not apply
error: patch failed: docs/operator-http-api.md:4051
error: docs/operator-http-api.md: patch does not apply
error: patch failed: docs/reservation.md:92
error: docs/reservation.md: patch does not apply
error: patch failed: docs/upgrades.md:381
error: docs/upgrades.md: patch does not apply
error: patch failed: docs/versioning.md:52
error: docs/versioning.md: patch does not apply
error: patch failed: docs/windows.md:54
error: docs/windows.md: patch does not apply
```
---
[GitHub] mesos issue #256: Correct spelling errors in the docs
Posted by bmahler <gi...@git.apache.org>.
Github user bmahler commented on the issue:
https://github.com/apache/mesos/pull/256
Hm.. I don't know if I'm looking at this right, but when I click 'Files Changed' I still see the "iff" and "acknowledgements" adjustments, so I wonder if your update took effect or if I'm not looking at the diff correctly?
---
[GitHub] mesos issue #256: Correct spelling errors in the docs
Posted by pleia2 <gi...@git.apache.org>.
Github user pleia2 commented on the issue:
https://github.com/apache/mesos/pull/256
Being more familiar with Gerrit than GitHub with forks, I may have made a bit of a mess here, LMK if you want me to untangle this further or create a new PR, but I think it's generally where we need to be.
---
[GitHub] mesos issue #256: Correct spelling errors in the docs
Posted by bmahler <gi...@git.apache.org>.
Github user bmahler commented on the issue:
https://github.com/apache/mesos/pull/256
Sorry about that, and thank you for your patience!
---
[GitHub] mesos pull request #256: Correct spelling errors in the docs
Posted by pleia2 <gi...@git.apache.org>.
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 issue #256: Correct spelling errors in the docs
Posted by pleia2 <gi...@git.apache.org>.
Github user pleia2 commented on the issue:
https://github.com/apache/mesos/pull/256
What a mess. I'll fiddle with my patch and see about submitting it over on the Review Board side.
---
[GitHub] mesos pull request #256: Correct spelling errors in the docs
Posted by pleia2 <gi...@git.apache.org>.
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
Posted by bmahler <gi...@git.apache.org>.
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
Posted by ralic <gi...@git.apache.org>.
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 issue #256: Correct spelling errors in the docs
Posted by pleia2 <gi...@git.apache.org>.
Github user pleia2 commented on the issue:
https://github.com/apache/mesos/pull/256
It seems the diff is unhelpfully showing the difference between the two commits, rather than from the source. Pulling it down to do a local squash and diff should show things properly.
---
[GitHub] mesos pull request #256: Correct spelling errors in the docs
Posted by bbannier <gi...@git.apache.org>.
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
Posted by pleia2 <gi...@git.apache.org>.
Github user pleia2 closed the pull request at:
https://github.com/apache/mesos/pull/256
---