Repository navigation
Describe the Shared Signals articles instead of naming them by their headings - #49
Merged
Merged
Conversation
Both places that point at it here used the page's former title, so a reader comparing the link text with the page it opens found two different names for one article. The address and its anchors did not change. The reference list puts its addresses in parentheses now. The new title carries a colon of its own, and the list's "title: address" shape then read as two titles run together; both entries changed, because one of them alone is what makes a list look unmaintained.
The link text in both places was the page's title. That is the shape that sent this branch here: the two places were already naming the guide by a title it had stopped carrying, and nothing noticed, because the link still resolved. Saying what the page is keeps the text true while the page is about the same thing. It also stops looking like a quotation, which is what makes a reader compare it with the heading and find a difference.
kirill-abblix
changed the title
The other entry in this list still named its page by the heading that page carries, which is the one shape that goes stale at the next rename. The label beside it already says what the article maps, so the text can be short and say what the reader gets. Neither entry quotes a heading now.
kirill-abblix
changed the title
This file contains hidden or 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
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.
Every place in this repository that pointed at one of the two Shared Signals articles named it by that article's heading. A heading changes, and the guide's already had: both links were calling it by a name it had stopped carrying. Nothing catches that, because the link still resolves, nothing fails, and the mismatch is visible only to someone who opens both.
The text now says what each page is rather than quoting what it is called, so it stays true while the page is about the same thing. Neither entry quotes a heading any more. The descriptive wording also avoids looking like a quotation: no colon and no list of terms, which is what makes a phrase read as a title somebody got wrong.
The reference list at the end of the sample's README puts its addresses in parentheses. The guide's former heading carried a colon of its own, and the list's "heading: address" shape read as two headings run together; both entries changed, because one of them alone is what makes a list look unmaintained.
The sentence that introduces the sample is rewritten rather than substituted: the new text is a noun phrase with an article and cannot stand where a proper name did.