Skip to content

[DOCS] Reorder some lines in the class diagram (part 1) #1306

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

Merged
merged 1 commit into from
Jul 7, 2025
Merged

Conversation

oliverklee
Copy link
Collaborator

This is in preparation for #1298.

@coveralls
Copy link

coveralls commented Jul 5, 2025

Coverage Status

coverage: 57.935%. remained the same
when pulling 1cccce6 on docs/reorder-1
into e69e8ca on main.

@oliverklee oliverklee changed the title [DOCS] Reorder some line in the class diagram (part 1) [DOCS] Reorder some lines in the class diagram (part 1) Jul 5, 2025
Copy link
Collaborator

@JakeQZ JakeQZ left a comment

Choose a reason for hiding this comment

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

I think the comments ("start/end of generated part") should be removed with this change, since they no longer apply. (Ultimately it will all be generated, so they will become unnecessary anyway.)

@oliverklee
Copy link
Collaborator Author

I think the comments ("start/end of generated part") should be removed with this change, since they no longer apply. (Ultimately it will all be generated, so they will become unnecessary anyway.)

I've temporarily removed them in #1307.

When we autogenerate the whole diagram again, we'll need to have those markers (or something similar) back, as we need to have something for the generation and insertion script to recognize which part to replace.

@oliverklee oliverklee requested a review from JakeQZ July 7, 2025 13:32
@JakeQZ JakeQZ merged commit f035185 into main Jul 7, 2025
21 checks passed
@JakeQZ JakeQZ deleted the docs/reorder-1 branch July 7, 2025 13:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants