Fix docstring error #171
Open
Fix docstring error #171
+7
−4
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
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.
Due to an external change, the result of
@docinside the@theorymacro returns aBase.Docs.DocStrobject rather than aMarkdown.MDobject. This broke some tests. This PR offers a partial fix. It is partial because the docstring one puts above@theorywas 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 ThCategorywill work the same as before, but there is a regression insofar asThCategory.Meta.theorywill not have documentation. (Hence, two lines are commented out in the tests now)