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

Add tests to Masonry's examples #844

Merged
merged 1 commit into from
Jan 22, 2025
Merged

Add tests to Masonry's examples #844

merged 1 commit into from
Jan 22, 2025

Conversation

PoignardAzur
Copy link
Contributor

No description provided.

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 will help us find test regressions.

Copy link
Member

@DJMcNab DJMcNab left a comment

Choose a reason for hiding this comment

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

Good to get these tested!

Copy link
Member

Choose a reason for hiding this comment

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

It's not immediately clear what this kind of test is actually for. Is there some documentation I can look at which explains that?

Is it just an aid to check that the right thing is being tested?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, I've kept them out of inertia, but I'm not really convinced they're helpful, especially after the changes to the pass system.

They were initially created for Panoramix, meaning they would be useful for Xilem: they let you assert that the tree is in the right shape after the build/rebuild step has been applied, that the right widgets are there with the right values, etc.

For Masonry though I think we might just remove most of them.

Copy link
Member

Choose a reason for hiding this comment

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

Using them for Xilem makes an awful lot of sense.

Comment on lines 97 to 99
# This actually enables scraping for all examples, not just this one.
# However it is possible to set doc-scrape-examples to false for other specific examples.
doc-scrape-examples = true
Copy link
Member

Choose a reason for hiding this comment

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

I think that this should probably be on the first item in this list.

Incidentally, it might be worth re-wording the comment; the reason this needs to exist is so that cargo doc knows that it is allowed to use dev-dependencies:
https://github.com/rust-lang/cargo/blob/master/src/doc/src/reference/unstable.md#scrape-examples

That needn't happen in this PR

@PoignardAzur PoignardAzur added this pull request to the merge queue Jan 22, 2025
Merged via the queue into main with commit df1efa4 Jan 22, 2025
18 checks passed
@PoignardAzur PoignardAzur deleted the test_examples branch January 22, 2025 11:24
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.

3 participants