Skip to content
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

doc(mixins): Add override annotation on some code examples #6240

Merged
merged 2 commits into from
Dec 2, 2024
Merged

doc(mixins): Add override annotation on some code examples #6240

merged 2 commits into from
Dec 2, 2024
+7 −0

Conversation

tilucasoli
Copy link
Contributor

include some override annotations for code examples that are not explicitly assigned.

  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
  • This PR doesn't contain automatically generated corrections or text (Grammarly, LLMs, and similar).
  • This PR follows the Google Developer Documentation Style Guidelines — for example, it doesn't use i.e. or e.g., and it avoids I and we (first person).
  • This PR uses semantic line breaks of 80 characters or fewer.
Contribution guidelines:
  • See our contributor guide for general expectations for PRs.
  • Larger or significant changes should be discussed in an issue before creating a PR.
  • Code changes should generally follow the Dart style guide and use dart format.
  • Updates to code excerpts indicated by <?code-excerpt need to be updated in their source .dart file as well.

@MaryaBelanger
Copy link
Contributor

/gcbrun

@dart-github-bot
Copy link
Collaborator

Visit the preview URL for this PR (updated for commit ad9037d):

https://dart-dev--pr6240-main-ovidomby.web.app

@MaryaBelanger
Copy link
Contributor

Thanks for this @tilucasoli! I'm going to push a commit that adds a small note saying that the overrides are implicit, so they can be omitted, but otherwise I agree that stating them explicitly is better for docs

@tilucasoli
Copy link
Contributor Author

tilucasoli commented Dec 2, 2024 •
edited
Loading

Thank you for your response! Where will you add this note? Will it be added to each page?

@MaryaBelanger
Copy link
Contributor

MaryaBelanger commented Dec 2, 2024 •
edited
Loading

I think probably around line 71, at the end of ## Specify members a mixin can call on itself but before ### Define abstract members in the mixin. That way we can say it applies to all the examples in the section (all the examples you edited)

Edit: Actually, I'm wavering on whether my note is necessary or not. I'll get back to you!

MaryaBelanger
MaryaBelanger approved these changes Dec 2, 2024
View reviewed changes
Copy link
Contributor

@MaryaBelanger MaryaBelanger left a comment

Choose a reason for hiding this comment

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

Decided against the note, so this is good to go! Thanks again @tilucasoli

@MaryaBelanger MaryaBelanger merged commit cb4aa78 into dart-lang:main Dec 2, 2024
9 of 10 checks passed
@MaryaBelanger MaryaBelanger mentioned this pull request Dec 2, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MaryaBelanger MaryaBelanger MaryaBelanger approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@tilucasoli @MaryaBelanger @dart-github-bot