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.

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

fix: Copy/paste typos in Menu status icon docs #2792

Merged
merged 2 commits into from
Aug 28, 2024

Conversation

mattcen
Copy link
Contributor

@mattcen mattcen commented Aug 28, 2024

Just a small doc fix to fix runtime errors in the Status Icon code example

As an aside, the docs also refer to "icons/green" and "icons/blue"; are these expected to exist in the source somewhere?

PR Checklist:

  • All new features have been tested
  • All new features have been documented
  • I have read the CONTRIBUTING.md file
  • I will abide by the code of conduct

Copy link
Member

@freakboy3742 freakboy3742 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 those corrections. The changes themselves look great; CI is currently failing because there's a need for a changes/2792.misc.rst that is a release note for this change.

As for the icons/blue and icons/green example icons - they don't exist in the docs; the values provided here are more as "this is the sort of value you'd use" example. The actual icons are loaded the same as any other toga Icon - so, they're handled as a path relative to the app module, with size, platform and file type suffixes appended depending on the platform).

Copy link
Member

@freakboy3742 freakboy3742 left a comment

Choose a reason for hiding this comment

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

Looks like you posted the changenote just as I posted my review :-) I've tweaked it slightly, but otherwise this now looks great! Thanks for the fix!

@mattcen
Copy link
Contributor Author

mattcen commented Aug 28, 2024

Thanks for the tweak, @freakboy3742!

@freakboy3742 freakboy3742 merged commit 22d5c1c into beeware:main Aug 28, 2024
35 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants