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

update docs workflow #194

Merged
merged 3 commits into from
May 30, 2024
Merged

update docs workflow #194

merged 3 commits into from
May 30, 2024

Conversation

lucaferranti
Copy link
Member

No description provided.

@lucaferranti lucaferranti requested a review from Kolaru September 19, 2023 07:41
@lucaferranti
Copy link
Member Author

failure is because there are some docstrings not included in the manual

┌ Error: 3 docstrings not included in the manual:
│ 
│     IntervalRootFinding.guarded_derivative_midpoint :: Union{Tuple{T}, Tuple{Function, Function, Interval{T}}} where T
│     IntervalRootFinding.newton :: Union{Tuple{T}, Tuple{Function, Function, Interval{T}}, Tuple{Function, Function, Interval{T}, Int64}} where T
│     IntervalRootFinding.newton_refine :: Union{Tuple{T}, Tuple{N}, Tuple{Function, Function, Union{Interval{T}, IntervalBox{N, T}}}} where {N, T}
│ 
│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in canonical @docs or @autodocs blocks.
└ @ Documenter ~/.julia/packages/Documenter/Meee1/src/utilities/utilities.jl:44
[ Info: Populate: populating indices.

we can relax the check or include those in the manual

@Kolaru
Copy link
Collaborator

Kolaru commented May 30, 2024

All those docstrings are associated to function that will be removed in #203, so I just went ahead and commented them out (not the most elegant solution, but practical).

(newton will only be accessible through the roots interface and guarded_derivative_mid is not necessary and was internal anyway).

Thanks a lot and sorry for the 8 months delay in this review 😬

@Kolaru Kolaru merged commit e7a6631 into master May 30, 2024
11 checks passed
@OlivierHnt OlivierHnt deleted the lf-docs branch December 9, 2024 02:16
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