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 docstring error #171

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Fix docstring error #171

wants to merge 3 commits into from

Conversation

kris-brown
Copy link
Collaborator

@kris-brown kris-brown commented Dec 8, 2024

Due to an external change, the result of @doc inside the @theory macro returns a Base.Docs.DocStr object rather than a Markdown.MD object. This broke some tests. This PR offers a partial fix. It is partial because the docstring one puts above @theory was copied in two places before: both the module and the GAT were given the same docstring before. However, I wasn't able to figure out how to get the fix to work for the GAT, though we do recover the same docstring as before at the module level.

Thus @doc ThCategory will work the same as before, but there is a regression insofar as ThCategory.Meta.theory will not have documentation. (Hence, two lines are commented out in the tests now)

@kris-brown kris-brown linked an issue Dec 8, 2024 that may be closed by this pull request
@kris-brown kris-brown self-assigned this Dec 8, 2024
Copy link

codecov bot commented Dec 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.56%. Comparing base (a129cb4) to head (3edf6f4).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #171      +/-   ##
==========================================
+ Coverage   93.85%   95.56%   +1.71%     
==========================================
  Files          38       38              
  Lines        2229     2232       +3     
==========================================
+ Hits         2092     2133      +41     
+ Misses        137       99      -38     

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

@kris-brown kris-brown added the bug Something isn't working label Dec 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Bad docstrings on theories in Julia v1.11
1 participant