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 docstrings and make them available in documenter.jl build #24

Merged
merged 7 commits into from
Nov 20, 2024

Conversation

josephmckinsey
Copy link
Collaborator

  • docs/src/api/public.md now has a list of public documented methods with a custom sorting
  • No "mainline" documentation is useful yet (quickstart, examples, etc)
  • Added documentation to several key PRAS functions (Shortfall, SequentialMonteCarlo, assess, SystemModel). I also re-export these and include them in the public documentation.

@josephmckinsey
Copy link
Collaborator Author

Fixes #13

src/PRASInterface.jl Show resolved Hide resolved
src/util/definitions.jl Outdated Show resolved Hide resolved
src/util/draws/draw_helper_functions.jl Show resolved Hide resolved
src/util/draws/draw_helper_functions.jl Outdated Show resolved Hide resolved
src/util/draws/draw_helper_functions.jl Outdated Show resolved Hide resolved
src/util/sienna/add_csv_time_series_data.jl Show resolved Hide resolved
@josephmckinsey josephmckinsey merged commit fa0a8b2 into main Nov 20, 2024
6 checks passed
@josephmckinsey josephmckinsey deleted the jm/fix_docstrings branch November 20, 2024 19:53
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