Skip to content

ci: remove outdated custom signature generation#2280

Merged
tonyandrewmeyer merged 2 commits intocanonical:mainfrom
tonyandrewmeyer:remove-outdated-doc-config
Jan 20, 2026
Merged

ci: remove outdated custom signature generation#2280
tonyandrewmeyer merged 2 commits intocanonical:mainfrom
tonyandrewmeyer:remove-outdated-doc-config

Conversation

@tonyandrewmeyer
Copy link
Copy Markdown
Collaborator

@tonyandrewmeyer tonyandrewmeyer commented Jan 20, 2026

In Ops 2.x, the Scenario state classes had a custom __new__ that provided keyword-only argument support for the data classes, since we had to support Python 3.8, which didn't have them.

Sphinx wasn't able to figure out the signature to display using our custom code, so we also had a custom Sphinx processor to do that.

When we removed the custom __new__ system, we missed removing the customisation in the docs. This PR does that.

Preview (should look unchanged from main).

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR removes outdated custom Sphinx documentation processing code that was previously needed to handle the _MaxPositionalArgs system, which provided keyword-only argument support for Scenario state classes in Python 3.8. Since the custom __new__ system has been removed (Python 3.8 is no longer supported), the custom Sphinx signature generation code is no longer needed.

Changes:

  • Removed custom Sphinx signature generation monkeypatch and helper functions

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@dwilding dwilding left a comment

Choose a reason for hiding this comment

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

Good catch, thanks! I did a diff between your branch and main and the reference docs match identically 💯

@tonyandrewmeyer tonyandrewmeyer merged commit 9db35ac into canonical:main Jan 20, 2026
75 of 76 checks passed
@tonyandrewmeyer tonyandrewmeyer deleted the remove-outdated-doc-config branch January 20, 2026 05:04
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.

4 participants