Skip to content

Fix references to symbols to use brackets instead of backticks #111331

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 2 commits into from
Sep 12, 2022
Merged

Fix references to symbols to use brackets instead of backticks #111331

merged 2 commits into from
Sep 12, 2022

Conversation

gspencergoog
Copy link
Contributor

@gspencergoog gspencergoog commented Sep 10, 2022 •
edited
Loading

Description

This fixes a bunch of places where we refer to the symbol being documented using `symbol` notation, when it would be really helpful in an IDE to have them be linked symbols, since we don't mind if a symbol links to itself, but using backticks makes those references invisible to the analyzer, so that refactorings, dart fixes, etc. don't see them.

Related Issues

Tests

  • Just doc changes, no code.

@flutter-dashboard flutter-dashboard bot added a: animation Animation APIs a: text input Entering text in a text field or keyboard related problems f: cupertino flutter/packages/flutter/cupertino repository f: focus Focus traversal, gaining or losing focus f: material design flutter/packages/flutter/material repository. f: routes Navigator, Router, and related APIs. f: scrolling Viewports, list views, slivers, etc. framework flutter/packages/flutter repository. See also f: labels. labels Sep 10, 2022
@gspencergoog gspencergoog marked this pull request as ready for review September 12, 2022 18:01
@gspencergoog gspencergoog requested a review from Hixie September 12, 2022 18:02
Hixie
Hixie approved these changes Sep 12, 2022
View reviewed changes
Copy link
Contributor

@Hixie Hixie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
LGTM
LGTM

@gspencergoog gspencergoog added the autosubmit Merge PR when tree becomes green via auto submit App label Sep 12, 2022
@auto-submit auto-submit bot merged commit 228ea2c into flutter:master Sep 12, 2022
@gspencergoog gspencergoog deleted the fix_symbol_refs branch September 12, 2022 18:31
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Sep 12, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/packages that referenced this pull request Sep 12, 2022
@engine-flutter-autoroll
228ea2c Fix references to symbols to use brackets instead of backticks (
daa7d45 
flutter/flutter#111331)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Sep 13, 2022
Closed
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Sep 13, 2022
@engine-flutter-autoroll
228ea2c Fix references to symbols to use brackets instead of backticks (
bdd4bd6 
flutter/flutter#111331)
@engine-flutter-autoroll engine-flutter-autoroll mentioned this pull request Sep 13, 2022
Merged
engine-flutter-autoroll added a commit to engine-flutter-autoroll/plugins that referenced this pull request Sep 13, 2022
@engine-flutter-autoroll
228ea2c Fix references to symbols to use brackets instead of backticks (
b3ce0ac 
flutter/flutter#111331)
@bleroux bleroux mentioned this pull request Nov 2, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Hixie Hixie Hixie approved these changes

Assignees
No one assigned
Labels
a: animation Animation APIs a: text input Entering text in a text field or keyboard related problems autosubmit Merge PR when tree becomes green via auto submit App f: cupertino flutter/packages/flutter/cupertino repository f: focus Focus traversal, gaining or losing focus f: material design flutter/packages/flutter/material repository. f: routes Navigator, Router, and related APIs. f: scrolling Viewports, list views, slivers, etc. framework flutter/packages/flutter repository. See also f: labels.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@gspencergoog @Hixie