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

Add missing docstrings to documentation #268

Closed
giordano opened this issue Mar 13, 2024 · 0 comments · Fixed by #280
Closed

Add missing docstrings to documentation #268

giordano opened this issue Mar 13, 2024 · 0 comments · Fixed by #280
Labels
documentation Improvements or additions to documentation

Comments

@giordano
Copy link
Member

I was trying in #267 to switch to Documenter.jl v1, which however turns on more strict checks and it appears there are some docstrings that we don't add to our docs:

┌ Error: 11 docstrings not included in the manual:
│ 
│     ParticleDA.get_state_indices_correlated_to_observations :: Tuple{Any}
│     ParticleDA.get_initial_state_mean!
│     ParticleDA.write_snapshot :: Union{Tuple{T}, Tuple{AbstractString, Any, NamedTuple, AbstractMatrix{T}, Int64, Bool}} where T
│     ParticleDA.write_state :: Tuple{HDF5.File, AbstractVector, Int64, String, Any}
│     ParticleDA.get_covariance_initial_state
│     ParticleDA.get_covariance_initial_state :: Tuple{Any}
│     ParticleDA.init_filter
│     ParticleDA.sample_proposal_and_compute_log_weights!
│     ParticleDA.write_observation :: Tuple{HDF5.File, AbstractVector, Int64, Any}
│     ParticleDA.write_weights :: Tuple{HDF5.File, AbstractVector, Int64, Any}
│     ParticleDA.get_initial_state_mean :: Tuple{Any}
@giordano giordano added the documentation Improvements or additions to documentation label Mar 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant