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

YaruLandscapeLayout: remove docs from an internal helper class #431

Merged
merged 1 commit into from Nov 30, 2022
Merged

YaruLandscapeLayout: remove docs from an internal helper class #431

merged 1 commit into from Nov 30, 2022

Conversation

jpnurmi
Copy link
Member

@jpnurmi jpnurmi commented Nov 30, 2022

YaruLandscapeLayout is an internal helper class. It's not exported from lib/yaru_widgets.dart. Its sibling YaruPortraitLayout doesn't have docs either.

The docs are not only annoying to maintain but also cause confusion in code reviews. Having docs makes it look like a public class. The class gets easily mixed up with YaruCompactLayout with a similar name that on the other hand is a public class.

@jpnurmi jpnurmi changed the title YaruLandscapeLayout: remove docs YaruLandscapeLayout: remove docs from an internal helper class Nov 30, 2022
@Feichtmeier Feichtmeier merged commit 657c01b into ubuntu:main Nov 30, 2022
@jpnurmi jpnurmi deleted the landscape-layout-docs branch November 30, 2022 18:53
@jpnurmi jpnurmi mentioned this pull request Jan 11, 2023
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.

None yet

2 participants