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 CI checks to ensure quasi-duplicate APIs stay synchronized #9775

Open
alice-i-cecile opened this issue Sep 12, 2023 · 1 comment
Open
Labels
A-Build-System Related to build systems or continuous integration D-Complex Quite challenging from either a design or technical perspective. Ask for help!

Comments

@alice-i-cecile
Copy link
Member

          With #9686 merged too, I wonder if there's a way we could automatically check or enforce that all of the methods and docs are kept in sync 🤔 A trait won't work, both because of ergonomics / discoverability, and because `QueryState` needs a `World`. We could use some horrible macro, but that hurts code readability. Maybe a CI check? I guess that's a question for another PR though.

Originally posted by @alice-i-cecile in #9774 (comment)

@alice-i-cecile alice-i-cecile added A-Build-System Related to build systems or continuous integration D-Complex Quite challenging from either a design or technical perspective. Ask for help! labels Sep 12, 2023
@alice-i-cecile
Copy link
Member Author

In addition to the listed Query methods, we would also want this for the EntityMut family of types, and the doc comments for many of our closely related bundles. I'm sure I've missed some, so feel free to chime in.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Build-System Related to build systems or continuous integration D-Complex Quite challenging from either a design or technical perspective. Ask for help!
Projects
None yet
Development

No branches or pull requests

1 participant