Fix C++ apigen page naming for variable template specializations #396
Conversation
This file contains 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
Previously, the page names for variable template specializations incorrectly included the template arguments within angle brackets, unlike class template specializations where such arguments were stripped. With this commit, template arguments are stripped and the entities are distinguished based on the user-specified `id`.
jbms
force-pushed
the
fix-cpp-apigen-var-template-specializations
branch
from
8a74a3f
to
0ec412c
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #396 +/- ##
==========================================
+ Coverage 81.96% 82.12% +0.16%
==========================================
Files 68 68
Lines 8678 8678
==========================================
+ Hits 7113 7127 +14
+ Misses 1565 1551 -14 ☔ View full report in Codecov by Sentry. |
2bndy5
approved these changes
Nov 1, 2024
copybara-service bot
pushed a commit
to google/tensorstore
that referenced
this pull request
Nov 1, 2024
- Leave HasBoxDomain specializations undocumented to workaround jbms/sphinx-immaterial#396. These specializations don't need separate documentation anyway. - Wrap built documentation in a zip file for storage as a github actions artifact to avoid case insensitivity issues. While sphinx-immaterial has an option for generating page names that are compatible with case-insensitive filesystems, the case-sensitive naming avoids an ugly hash in the name and is preferable for documentation URLs. - Disable building wheels for Python 3.13 until the Python dependencies are updated to support it. PiperOrigin-RevId: 692221563 Change-Id: I374d30b6799908e419e17c1c48c5de16eda00505
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.
Previously, the page names for variable template specializations incorrectly included the template arguments within angle brackets, unlike class template specializations where such arguments were stripped.
With this commit, template arguments are stripped and the entities are distinguished based on the user-specified
id.