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

Tweak documentation for readability #787

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Tweak documentation for readability #787

wants to merge 5 commits into from

Conversation

PoignardAzur
Copy link
Contributor

@PoignardAzur PoignardAzur commented Dec 14, 2024

Apply many small tweaks I found while going over the documentation.
Rename some variables.
Add asserts to BoxConstraints::constrain_aspect_ratio.
Flesh out the WidgetState documentation.
Introduce the concept of "zombie flags".

@PoignardAzur
Copy link
Contributor Author

I'd say this is ready for review.

It's a bit of a kitchen sink PR, but almost all the changes are to documentation or comments only, and almost none of them change executable code.

Some changes remove long-dead code, bitrotted comments, outdated documentation, etc. Masonry's documentation has a tendency to refer to old ideas as if we were just about to implement them, so I think this spring cleaning will make it more readable.

Copy link
Contributor

@jaredoconnell jaredoconnell left a comment

Choose a reason for hiding this comment

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

This is an improvement.

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