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

text builder: resolve an ordering conflict between two section-number-related tests #12868

Conversation

jayaddison
Copy link
Contributor

@jayaddison jayaddison commented Sep 7, 2024

Feature or Bugfix

  • Bugfix

Purpose

  • Removes a test suite runtime order conflict between test_build_text.test_secnums and test_build_text.test_nonascii_title_line.

Detail

  • The test_nonascii_title_line test needs a two-character text_add_secnumbers configuration to pass successfully. The test_secnums test can interfere with this if it runs first, because it modifies that configuration setting, and by default Sphinx env does not reload configuration values in-process after a build has already taken place.

Relates

Edit(s): various attempts to improve the clarity of this pull request's description.

@jayaddison jayaddison changed the title Test order-oblivity: force rebuild during test_build_text.test_nonascii_title_line Test order-agnosticism: force rebuild during test_build_text.test_nonascii_title_line Sep 8, 2024
@jayaddison jayaddison changed the title Test order-agnosticism: force rebuild during test_build_text.test_nonascii_title_line text builder: resolve an ordering conflict between two section-number-related tests Sep 8, 2024
@jayaddison jayaddison requested a review from picnixz September 8, 2024 16:46
@picnixz
Copy link
Member

picnixz commented Sep 8, 2024

Hum, why do we have this mypy failure?

@jayaddison
Copy link
Contributor Author

Hum, why do we have this mypy failure?

That's due to the issue reported in #12864, I think.

Copy link
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

Since I didn't integrate the xdist feature yet, I'm ok with this.

@picnixz picnixz merged commit abb3ead into sphinx-doc:master Sep 28, 2024
23 checks passed
@picnixz
Copy link
Member

picnixz commented Sep 28, 2024

Thank you Jay!

@jayaddison
Copy link
Contributor Author

Thanks @picnixz! That also reminds me to re-read your test framework pull requests again soon (I think they'll make more sense to me now with some improved understanding of the codebase).

@picnixz
Copy link
Member

picnixz commented Sep 28, 2024

That also reminds me to re-read your test framework pull requests again soon

It's not really pressing. It's nice for the CI because we would make it run under a minute but we could hit other issues when used in production. But thank you for the suggestion! I will need to fix the conflicts before you review it again though.

@AA-Turner AA-Turner added this to the 8.1.x milestone Oct 6, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Nov 6, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[tests] ToC: ordering condition involving title generation.
3 participants