Add missing links for management plane and strong consistency #1215
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
noahdietz
requested changes
Sep 12, 2023
| @@ -60,8 +60,8 @@ rpc CreateBook(CreateBookRequest) returns (Book) { | |||
| - There **should** be exactly one `google.api.method_signature` annotation, | |||
| with a value of `"parent,{resource},{resource}_id"`, or "`"parent,{resource}"` | |||
| if the resource ID is not required. | |||
| - If the API is operating on the [management plane][], the operation should have | |||
| [strong consistency][]: the completion of a create operation **must** mean | |||
| - If the API is operating on the [management plane](https://google.aip.dev/111#management-plane), the operation should have | |||
There was a problem hiding this comment.
Suggested change
| - If the API is operating on the [management plane](https://google.aip.dev/111#management-plane), the operation should have | |
| - If the API is operating on the [management plane][], the operation should have |
Revert this, please. The change you've made isn't necessary, this already properly linked:
| - If the API is operating on the [management plane][], the operation should have | ||
| [strong consistency][]: the completion of a create operation **must** mean | ||
| - If the API is operating on the [management plane](https://google.aip.dev/111#management-plane), the operation should have | ||
| [strong consistency](https://google.aip.dev/121#strong-consistency): the completion of a create operation **must** mean |
There was a problem hiding this comment.
We prefer to use text references instead of inline links. The reason this isn't linking properly is because the text reference at the bottom is not aligned with the text here. The text here is strong consistency but the text reference on line 216 (incorrectly) expects strongly consistent. That should be corrected to strong consistency instead so that this text reference link works unchanged.
Suggested change
| [strong consistency](https://google.aip.dev/121#strong-consistency): the completion of a create operation **must** mean | |
| [strong consistency][]: the completion of a create operation **must** mean |
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.
No description provided.