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

Fixup: add missing call operator in template #299

Merged
merged 2 commits into from
Oct 2, 2024
Merged

Fixup: add missing call operator in template #299

merged 2 commits into from
Oct 2, 2024

Conversation

jayaddison
Copy link
Contributor

@jayaddison jayaddison commented Oct 2, 2024

Is the PR a fix or a feature?
Fix

Describe the changes in the PR
The super keyword used in a statement in the HTML footer template was missing parentheses to perform a method call; this caused the template rendering to emit a Python string describing the parent template object, instead of rendering the parent template as intended.

Does this PR close any issues?
Closes #298.

Does the PR change/update the following, if relevant?

  • Documentation
  • Tests
  • CHANGELOG

The `super` keyword used in a statement in the HTML footer
template was missing parentheses to perform a method call; this
caused the template rendering to emit a Python string describing
the parent template object, instead of rendering the parent
template as intended.
@bskinn
Copy link
Owner

bskinn commented Oct 2, 2024

Ah good, the CI is still happy.

Please add a CHANGELOG entry for this, using the format already present in the file. Create a new ### *(unreleased)* section at the top, and put this fix as a bullet under #### Fixed.

No tests needed.

Thanks!

@bskinn
Copy link
Owner

bskinn commented Oct 2, 2024

The CI failure here was in the final docs linkcheck job, because for some reason Stack Overflow was complaining about too many requests to a particular Q&A post.

Proceeding to merge despite the failing CI, because the only failure is a trivial/transient problem.

Thanks for the fix, @jayaddison!

@bskinn bskinn merged commit ff9151a into bskinn:main Oct 2, 2024
24 of 26 checks passed
@jayaddison
Copy link
Contributor Author

You're welcome - thanks @bskinn!

@jayaddison jayaddison deleted the issue-298/html-footer-template-fixup branch October 2, 2024 15:50
@jayaddison
Copy link
Contributor Author

Hi @bskinn - do you have any plans to release an updated version with this fixup in place? The reason I ask is that I think it should fix some documentation build reproducibility issues for the python-sphobjinv package in Debian (ref: https://tests.reproducible-builds.org/debian/rb-pkg/unstable/amd64/python-sphobjinv.html ). Thanks either way!

@bskinn
Copy link
Owner

bskinn commented Dec 9, 2024

Ah - I had planned to merge this once #296 was finished, but then we decided not to merge and I'd forgotten this needed to go in.

I need to make a maintenance release anyways, with 3.13 now out of rc, so - yes, I'll get a new version cut soon.

So, yeah, thanks for the nudge and the tracker link, @jayaddison -- I hadn't appreciated that this would be fixing a specific problem out there!

@jayaddison
Copy link
Contributor Author

No problem - thank you!

@bskinn bskinn mentioned this pull request Dec 28, 2024
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.

[DOC] HTML footer: super-template evaluation problem
2 participants