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

Fix links for nested types #90

Merged
merged 6 commits into from
Mar 11, 2024
Merged

Conversation

jabraham17
Copy link
Member

@jabraham17 jabraham17 commented Mar 11, 2024

This PR adjusts the handling of class names to correctly create links for nested types.

See doc-test/nested.rst for an example. Previously MyMod.TopLevel.baz would incorrectly be linked as MyMod.baz

[Reviewed by @lydia-duncan]

Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
@jabraham17 jabraham17 requested a review from lydia-duncan March 11, 2024 22:19
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
Copy link

codecov bot commented Mar 11, 2024

Codecov Report

Attention: Patch coverage is 10.00000% with 9 lines in your changes are missing coverage. Please review.

Project coverage is 41.59%. Comparing base (515d516) to head (f5b4ae4).
Report is 3 commits behind head on main.

Files Patch % Lines
sphinxcontrib/chapeldomain/__init__.py 10.00% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #90      +/-   ##
==========================================
- Coverage   42.07%   41.59%   -0.49%     
==========================================
  Files           2        2              
  Lines         549      553       +4     
==========================================
- Hits          231      230       -1     
- Misses        318      323       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@lydia-duncan lydia-duncan left a comment

Choose a reason for hiding this comment

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

Looks good otherwise!

Signed-off-by: Jade Abraham <jade.abraham@hpe.com>
@jabraham17 jabraham17 merged commit e00a752 into chapel-lang:main Mar 11, 2024
1 of 3 checks passed
@jabraham17 jabraham17 deleted the fix-links branch March 11, 2024 22:41
jabraham17 added a commit to chapel-lang/chapel that referenced this pull request Mar 12, 2024
This PR pulls in a fix from sphinxcontrib-chapeldomain that fixes how
links for nested types are rendered. This PR also adds a test for
chpldoc to lock in the correct behavior.

See chapel-lang/sphinxcontrib-chapeldomain#90
for details of the fix

[Reviewed by @lydia-duncan]
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.

2 participants