Remove attempt to detect fieldnames for functions which lead to error
#113
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
|
OK new error These are docstrings in the checked modules (configured with the modules keyword)
that are not included in canonical @docs or @autodocs blocks.
Error: linkcheck 'https://github.com/CDCgov/Rt-without-renewal/tree/a18526289735739427a468c5b3d6c162aa0235a9//src/utilities.jl#L166' status: 404.
Error: linkcheck 'https://github.com/CDCgov/Rt-without-renewal/tree/a18526289735739427a468c5b3d6c162aa0235a9//src/epi-models.jl#L106' status: 404.
Error: linkcheck 'https://github.com/CDCgov/Rt-without-renewal/tree/a18526289735739427a468c5b3d6c162aa0235a9//src/utilities.jl#L229' status: 404.
Error: linkcheck 'https://github.com/CDCgov/Rt-without-renewal/tree/a18526289735739427a468c5b3d6c162aa0235a9//src/utilities.jl#L210' status: 404.
Error: linkcheck 'https://github.com/CDCgov/Rt-without-renewal/tree/a18526289735739427a468c5b3d6c162aa0235a9//src/utilities.jl#L132' status: 404.
Error: linkcheck 'https://github.com/CDCgov/Rt-without-renewal/tree/a18526289735739427a468c5b3d6c162aa0235a9//src/utilities.jl#L194' status: 404.
Populate: populating indices.
ERROR: LoadError: `makedocs` encountered an error [:linkcheck] -- terminating build before rendering. |
|
These link errors point at where we've manually included docstrings with the proposed template; they were warnings in local build upgraded to full errors in CI |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #113 +/- ##
=======================================
Coverage 97.74% 97.74%
=======================================
Files 6 6
Lines 133 133
=======================================
Hits 130 130
Misses 3 3 ☔ View full report in Codecov by Sentry. |
|
This passes and has fixed the main error, but I recommend if merged an issue on why the link checking was erroring. |
This looks to me to be because we aren't including functions in the internal or public API blocks at all at the moment (because they were erroring due to lack of docs). |
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.
This aims to fix #108 .
The problem appears to be that we were setting a document
@templatefor function, methods and macros which included fieldnames. Those objects don't have fieldnames, so this was chucking an error (this really should be a warning IMO...).