-
-
Notifications
You must be signed in to change notification settings - Fork 3.9k
Write real docs for SystemSet
#19538
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
base: main
Are you sure you want to change the base?
Conversation
Show an example of adding a system to a system set. (Or link to a place which explains it). |
Nit: I would probably want to steer novices in the direction of using |
Me too! Unfortunately, this is in |
Ugh, I have run into that problem as well. Makes it hard to tell a coherent story if you can't talk about the purposes for which a given thing exists. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One typo, but otherwise LGTM!
Co-authored-by: theotherphil <[email protected]>
Objective
SystemSet
s are surprisingly rich and nuanced, but are extremely poorly documented.Fixes #19536.
Solution
Explain the basic concept of system sets, how to create them, and give some opinionated advice about their more advanced functionality.
Follow-up
I'd like proper module level docs on system ordering that I can link to here, but they don't exist. Punting to follow-up!