Stream: fhircast-github
Topic: fhircast-docs / PR #348 Editorial changes.
Github Notifications (FHIRcast) (Dec 02 2020 at 20:37):
GinoCanessa opened PR #348 from master to master:
Just a pass of editorial-type changes (Isaac did an open request on a call earlier this week). I've listed a few specific questions below, but request that someone else reviews EACH change; I tried to keep to strictly corrections, but assume I made some style changes as well. Most of the changes fall into only a few categories: conformance language capitalization, acronym consistency capitalization (e.g., JSON), and cleaning up things from other edits (e.g., something was added to a sentence and mismatched plurality).
Note: I won't be offended by any changes/corrections/disregarding of any suggestions in this PR.
Some specific questions:
- FHIRcast Authorization & SMART scopes, paragraph 1: I've changed "should" to "SHOULD" to call out conformance language, but am wondering if the intent was SHALL.
- Subscription Response, paragraph 2: "is not meant to be shown to the end user". I believe there should be conformance language here, but I'm not comfortable recommending what that is (e.g., SHOULD NOT / SHALL NOT).
- General: dictionaries don't find "unsubscription"; I believe the intent where it was used is clear, but I did change it in this PR (again, feel free to disregard those edits).
Cheers!
Github Notifications (FHIRcast) (Dec 08 2020 at 14:05):
isaacvetter requested isaacvetter for a review on PR #348.
Github Notifications (FHIRcast) (Dec 08 2020 at 14:05):
isaacvetter requested isaacvetter and wmaethner for a review on PR #348.
Github Notifications (FHIRcast) (Dec 08 2020 at 14:05):
isaacvetter requested isaacvetter, wmaethner and NiklasSvenzen for a review on PR #348.
Github Notifications (FHIRcast) (Dec 15 2020 at 15:55):
isaacvetter submitted PR Review.
Github Notifications (FHIRcast) (Dec 15 2020 at 15:55):
isaacvetter created PR Review Comment:
A Hub may not support the *_elements* query parameter; a subscriber SHALL gracefully handle receiving a full FHIR resource in the context of a notification.
Github Notifications (FHIRcast) (Dec 15 2020 at 15:56):
isaacvetter updated PR #348 from master to master:
Just a pass of editorial-type changes (Isaac did an open request on a call earlier this week). I've listed a few specific questions below, but request that someone else reviews EACH change; I tried to keep to strictly corrections, but assume I made some style changes as well. Most of the changes fall into only a few categories: conformance language capitalization, acronym consistency capitalization (e.g., JSON), and cleaning up things from other edits (e.g., something was added to a sentence and mismatched plurality).
Note: I won't be offended by any changes/corrections/disregarding of any suggestions in this PR.
Some specific questions:
- FHIRcast Authorization & SMART scopes, paragraph 1: I've changed "should" to "SHOULD" to call out conformance language, but am wondering if the intent was SHALL.
- Subscription Response, paragraph 2: "is not meant to be shown to the end user". I believe there should be conformance language here, but I'm not comfortable recommending what that is (e.g., SHOULD NOT / SHALL NOT).
- General: dictionaries don't find "unsubscription"; I believe the intent where it was used is clear, but I did change it in this PR (again, feel free to disregard those edits).
Cheers!
Github Notifications (FHIRcast) (Dec 15 2020 at 15:58):
NiklasSvenzen submitted PR Review.
Github Notifications (FHIRcast) (Dec 15 2020 at 15:58):
isaacvetter submitted PR Review.
Github Notifications (FHIRcast) (Dec 15 2020 at 15:58):
isaacvetter created PR Review Comment:
If a Hub finds any errors in the subscription request, an appropriate HTTP error response code (4xx or 5xx) SHALL be returned. In the event of an error, the Hub SHOULD return a description of the error in the response body as plain text, to be used by the client developer to understand the error. This is not meant to be shown to the end user. Hubs MAY decide to reject some subscription requests based on their own policies.
Github Notifications (FHIRcast) (Dec 15 2020 at 15:59):
isaacvetter updated PR #348 from master to master:
Just a pass of editorial-type changes (Isaac did an open request on a call earlier this week). I've listed a few specific questions below, but request that someone else reviews EACH change; I tried to keep to strictly corrections, but assume I made some style changes as well. Most of the changes fall into only a few categories: conformance language capitalization, acronym consistency capitalization (e.g., JSON), and cleaning up things from other edits (e.g., something was added to a sentence and mismatched plurality).
Note: I won't be offended by any changes/corrections/disregarding of any suggestions in this PR.
Some specific questions:
- FHIRcast Authorization & SMART scopes, paragraph 1: I've changed "should" to "SHOULD" to call out conformance language, but am wondering if the intent was SHALL.
- Subscription Response, paragraph 2: "is not meant to be shown to the end user". I believe there should be conformance language here, but I'm not comfortable recommending what that is (e.g., SHOULD NOT / SHALL NOT).
- General: dictionaries don't find "unsubscription"; I believe the intent where it was used is clear, but I did change it in this PR (again, feel free to disregard those edits).
Cheers!
Github Notifications (FHIRcast) (Dec 15 2020 at 16:01):
isaacvetter submitted PR Review.
Github Notifications (FHIRcast) (Dec 30 2020 at 16:10):
isaacvetter updated PR #348 from master to master:
Just a pass of editorial-type changes (Isaac did an open request on a call earlier this week). I've listed a few specific questions below, but request that someone else reviews EACH change; I tried to keep to strictly corrections, but assume I made some style changes as well. Most of the changes fall into only a few categories: conformance language capitalization, acronym consistency capitalization (e.g., JSON), and cleaning up things from other edits (e.g., something was added to a sentence and mismatched plurality).
Note: I won't be offended by any changes/corrections/disregarding of any suggestions in this PR.
Some specific questions:
- FHIRcast Authorization & SMART scopes, paragraph 1: I've changed "should" to "SHOULD" to call out conformance language, but am wondering if the intent was SHALL.
- Subscription Response, paragraph 2: "is not meant to be shown to the end user". I believe there should be conformance language here, but I'm not comfortable recommending what that is (e.g., SHOULD NOT / SHALL NOT).
- General: dictionaries don't find "unsubscription"; I believe the intent where it was used is clear, but I did change it in this PR (again, feel free to disregard those edits).
Cheers!
Github Notifications (FHIRcast) (Dec 30 2020 at 16:10):
isaacvetter merged PR #348.
Last updated: Apr 12 2022 at 19:14 UTC
