Replace <em> with <span> for desc_annotation semantic HTML #13689
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Replace <em class="property"> with <span class="property"> in HTML5 writer's visit_desc_annotation and depart_desc_annotation methods to improve semantic HTML structure for Python attribute type annotations. Fixes sphinx-doc#13688 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
q2mark
force-pushed
the
fix-desc-annotation-semantic
branch
from
0288b94 to
bba4f3d
Compare
|
Hi @q2mark this commit has the author of "Claude". Please confirm that this PR is entirely comprised of your own work, and you posses the legal right to copyright. A |
AA-Turner
added
the
awaiting:response
@AA-Turner yes this is entirely my own work and I have the right to copyright. |
AA-Turner
reviewed
Jun 23, 2025
Comment on lines
+82
to
+84
| * #13688: HTML5: Replace ``<em class="property">`` with ``<span class="property">`` | ||
| for Python attribute type annotations to improve semantic HTML structure. | ||
| Patch by Mark O. |
There was a problem hiding this comment.
Do you have a suggested link / reference for "semantic HTML structure"?
Suggested change
| * #13688: HTML5: Replace ``<em class="property">`` with ``<span class="property">`` | |
| for Python attribute type annotations to improve semantic HTML structure. | |
| Patch by Mark O. | |
| * #13688: HTML builder: Replace ``<em class="property">`` with ``<span class="property">`` | |
| for Python attribute type annotations to improve semantic HTML structure. | |
| Patch by Mark Ostroth. |
|
Oh, please also add yourself to AUTHORS. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
This PR replaces
<em class="property">with<span class="property">in the HTML5 writer'svisit_desc_annotationanddepart_desc_annotationmethods to improve semantic HTML structure for Python attribute type annotations.Changes:
sphinx/writers/html5.pyto use<span>instead of<em>tags while maintaining the existingpropertyCSS classtests/test_domains/test_domain_py_pyobject.pyBenefits:
The change maintains all existing functionality and CSS styling while providing better semantic meaning.
References