Skip to content

Added Small Doc Enhancement in Badge #143319

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
Closed
piedcipher wants to merge 1 commit into from
Closed

Added Small Doc Enhancement in Badge #143319

piedcipher wants to merge 1 commit into from

Conversation

@piedcipher
Copy link
Member

@piedcipher piedcipher commented Feb 12, 2024 •
edited
Loading

Importing navigation_rail and text_button enables the code navigation.

Before After
screenshot_2024-02-12_at_11 40 20___pm screenshot_2024-02-12_at_11 40 11___pm

Pre-launch Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
  • I read the Tree Hygiene wiki page, which explains my responsibilities.
  • I read and followed the Flutter Style Guide, including Features we expect every widget to implement.
  • I signed the CLA.
  • I listed at least one issue that this PR fixes in the description above.
  • I updated/added relevant documentation (doc comments with ///).
  • I added new tests to check the change I am making, or this PR is test-exempt.
  • All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

@flutter-dashboard
Copy link

flutter-dashboard bot commented Feb 12, 2024

It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact "@test-exemption-reviewer" in the #hackers channel in Chat (don't just cc them here, they won't see it! Use Discord!).

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing.

@github-actions github-actions bot added framework flutter/packages/flutter repository. See also f: labels. f: material design flutter/packages/flutter/material repository. labels Feb 12, 2024
@Hixie
Copy link
Contributor

Hixie commented Feb 12, 2024

Isn't this a bug in the doc navigation itself, rather than in the code?

@Hixie
Copy link
Contributor

Hixie commented Feb 12, 2024

test-exempt: doesn't affect generated code

@HansMuller HansMuller self-requested a review February 16, 2024 18:10
HansMuller
HansMuller approved these changes Feb 16, 2024
View reviewed changes
Copy link
Contributor

@HansMuller HansMuller left a comment

Choose a reason for hiding this comment

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

Thanks for the fix! LGTM

@HansMuller HansMuller added the autosubmit Merge PR when tree becomes green via auto submit App label Feb 16, 2024
@auto-submit auto-submit bot removed the autosubmit Merge PR when tree becomes green via auto submit App label Feb 16, 2024
@auto-submit
Copy link
Contributor

auto-submit bot commented Feb 16, 2024

auto label is removed for flutter/flutter/143319, due to This PR has not met approval requirements for merging. The PR author is not a member of flutter-hackers and needs 1 more review(s) in order to merge this PR.

  • Merge guidelines: A PR needs at least one approved review if the author is already part of flutter-hackers or two member reviews if the author is not a flutter-hacker before re-applying the autosubmit label. Reviewers: If you left a comment approving, please use the "approve" review action instead.

@piedcipher
Copy link
Member Author

piedcipher commented Feb 16, 2024 •
edited
Loading

Thanks for the fix! LGTM

Thanks for the review! I've seen similar issue in many files. Importing always solves it.

@piedcipher
Copy link
Member Author

piedcipher commented Feb 16, 2024

auto label is removed for flutter/flutter/143319, due to This PR has not met approval requirements for merging. The PR author is not a member of flutter-hackers and needs 1 more review(s) in order to merge this PR.

  • Merge guidelines: A PR needs at least one approved review if the author is already part of flutter-hackers or two member reviews if the author is not a flutter-hacker before re-applying the autosubmit label. Reviewers: If you left a comment approving, please use the "approve" review action instead.

I'm not a collaborator so will need one more LGTM ✅🏁

I'm interested in becoming one if there is an opportunity. I've landed 22 PRs in flutter/flutter, 37 in flutter/website & 2 in flutter/packages 🌱🌻

loic-sharma
loic-sharma approved these changes Feb 16, 2024
View reviewed changes
Copy link
Member

@loic-sharma loic-sharma left a comment

Choose a reason for hiding this comment

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

Thanks!

@gspencergoog
Copy link
Contributor

gspencergoog commented Feb 17, 2024

Wait, wait, those symbols aren't used in the code, only in the docs. I understand wanting to do this (I've wanted to do it myself), but taken to the limit, there will be layer violations, since some doc comments refer to symbols that are not allowed to be referenced in the code in the library that they are in.

Here it is harmless, but I'm just worried about being consistent.

The Dartdoc team is working on a way to specify doc-only imports, and that is the way to eventually solve this (they're basically import statements in a doc comment).

justinmc
justinmc requested changes Feb 17, 2024
View reviewed changes
Copy link
Contributor

@justinmc justinmc left a comment

Choose a reason for hiding this comment

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

I agree with @gspencergoog, so I think this PR should be closed. Thank you for opening the PR and getting this conversation started though. I've noticed the same thing and wondered whether or not we should be importing stuff in the docs.

I'm happy to sponsor you for contributor access by the way. See the wiki if you haven't yet.

@piedcipher
Copy link
Member Author

piedcipher commented Feb 17, 2024 •
edited
Loading

Wait, wait, those symbols aren't used in the code, only in the docs. I understand wanting to do this (I've wanted to do it myself), but taken to the limit, there will be layer violations, since some doc comments refer to symbols that are not allowed to be referenced in the code in the library that they are in.

Here it is harmless, but I'm just worried about being consistent.

The Dartdoc team is working on a way to specify doc-only imports, and that is the way to eventually solve this (they're basically import statements in a doc comment).

I agree with @gspencergoog, so I think this PR should be closed. Thank you for opening the PR and getting this conversation started though. I've noticed the same thing and wondered whether or not we should be importing stuff in the docs.

when I sent the pr, somewhere I realised I was doing something wrong (and importing might be wrong) when I saw this issue in multiple places, thank you! my bad

closing the PR.

@piedcipher
Copy link
Member Author

piedcipher commented Feb 17, 2024

I'm happy to sponsor you for contributor access by the way. See the wiki if you haven't yet.

Thank a lot for the opportunity! I've read these and committed to following these and very happy to join the Flutter team. 💙

@piedcipher piedcipher closed this Feb 17, 2024
@piedcipher piedcipher deleted the fix/doc_typo branch February 17, 2024 07:03
@piedcipher
Copy link
Member Author

piedcipher commented Feb 26, 2024

I'm happy to sponsor you for contributor access by the way. See the wiki if you haven't yet.

Thank a lot for the opportunity! I've read these and committed to following these and very happy to join the Flutter team. 💙

hi @justinmc, what are the next steps? my username on discord is same as GitHub.

@piedcipher piedcipher mentioned this pull request Mar 5, 2024
Merged
8 tasks
@justinmc
Copy link
Contributor

justinmc commented Mar 6, 2024

@piedcipher Sponsored: https://discord.com/channels/608014603317936148/611619879153565715/1215053910562316348

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@justinmc justinmc justinmc requested changes

@loic-sharma loic-sharma loic-sharma approved these changes

+1 more reviewer

@HansMuller HansMuller HansMuller approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

f: material design flutter/packages/flutter/material repository. 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.

6 participants

@piedcipher @Hixie @gspencergoog @justinmc @loic-sharma @HansMuller