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

Update doc class references #2003

Merged
merged 2 commits into from
Jun 21, 2023
Merged

Update doc class references #2003

merged 2 commits into from
Jun 21, 2023

Conversation

freakboy3742
Copy link
Member

Fixes #2001.

Modifies all the class references in documentation and source from the definition location to the preferred import location (generally toga.X rather than toga.widgets.x.X).

I'm not 100% happy with the fact that :class:toga.Foo anchors at the start of the class definition, rather than the top of the page, but I'm also not sure I see a way to fix that. Changing to toga.Widget format is a significant improvement, and it's no worse that it was before, so I figure this is an incremental improvement.

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

@mhsmith mhsmith merged commit e73b645 into beeware:main Jun 21, 2023
42 checks passed
@freakboy3742 freakboy3742 deleted the docs-refs branch June 21, 2023 23:25
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.

Documentation leaks internal package structure
2 participants