Editorial changes after RFC review #108
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Excuse the trailing whitespace changes, but then the other changes should be about as meaning-preserving. One thing that may look meaning-changing: I'm dropping a paragraph on semantics of error_message-carrying rows. But that, I claim, is discussed exhaustively above.
mbtaylor
reviewed
Jul 10, 2023
| Note this is applicable to endpoints following any version 1.* | ||
| of the DataLink standard, to avoid backward compatibility problems. | ||
| Note that this (minor-versioned) URI is applicable to endpoints following any version 1.* | ||
| of the DataLink standard. |
There was a problem hiding this comment.
Since I think everybody agrees that the version ID should be #links-1.1, I guess this part will be revised anyway.
| Since NULL values are not permitted in the semantics column, when only | ||
| an error\_message is supplied its value \rfcshould\ be the most appropriate | ||
| for the link the service was trying to generate. | ||
|
|
There was a problem hiding this comment.
I don't know that requiring non-NULL semantics is a good idea, but as long as it's in place, I'd say this guidance for what to do there in case of an error response is useful. Why remove it?
|
On Mon, Jul 10, 2023 at 05:18:04AM -0700, Mark Taylor wrote:
-Since NULL values are not permitted in the semantics column, when only
-an error\_message is supplied its value \rfcshould\ be the most appropriate
-for the link the service was trying to generate.
-
I don't know that requiring non-NULL semantics is a good idea, but
as long as it's in place, I'd say this guidance for what to do
there in case of an error response is useful. Why remove it?
It repeats information from 3.2.4, where it says:
If an error_message is included in the output, the ID and semantics
values must be provided as usual.
There is something to be said for repeating a piece of information in
multiple places, but if we do it, it should probably be about the
same language in both places, or people will become confused.
|
|
Then I would say it's worth preserving (in either place) the comment that "its value should be the most appropriate for the link the service was trying to generate", since (although I don't really know what else you'd do) it's not really obvious what the function of the semantics is in that case. |
|
On Mon, Jul 10, 2023 at 08:26:36AM -0700, Mark Taylor wrote:
Then I would say it's worth preserving (in either place) the
comment that "its value should be the most appropriate for the link
the service was trying to generate", since (although I don't really
know what else you'd do) it's not really obvious what the function
of the semantics is in that case.
Ok, so you're saying "as usual" in 3.2.4 is not really clear? Fair
enough.
What about:
If an error_message is included in the output, the ID and semantics
values must be provided as usual; in particular, the value in the
semantics column should reflect the semantics of the link that
could not be produced.
Improvements much appreciated, of course.
|
|
Yes, that sounds fine. |
(this was requested by Mark to make up for dropping clear language in 3.2.6 in the previouw commit).
mbtaylor
approved these changes
Jul 11, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Excuse the trailing whitespace changes, but then the other changes should be about as meaning-preserving.
One thing that may look meaning-changing: I'm dropping a paragraph on semantics of error_message-carrying rows. But that, I claim, is discussed exhaustively above.
I have, in addition, a few less meaning-preserving suggestions; see
https://wiki.ivoa.net/twiki/bin/view/IVOA/DataLink11RFC#Community%20Comment%20by%20Markus%20Deml