Skip to content

Commit

Permalink
Merge #302
Browse files Browse the repository at this point in the history
302: minor typo fix for docstring of get_ϕ r=odunbar a=wilsonduan10

<!--- THESE LINES ARE COMMENTED -->
## Purpose 
<!--- One sentence to describe the purpose of this PR, refer to any linked issues:
#14 -- this will link to issue 14
Closes #2 -- this will automatically close issue 2 on PR merge
-->
Fixed a typo in the docstring

## To-do
<!---  list of proposed tasks in the PR, move to "Content" on completion 
- Proposed task
-->


## Content
<!---  specific tasks that are currently complete 
- Solution implemented
-->


<!---
Review checklist

I have:
- followed the codebase contribution guide: https://clima.github.io/ClimateMachine.jl/latest/Contributing/
- followed the style guide: https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/
- followed the documentation policy: https://github.com/CliMA/policies/wiki/Documentation-Policy
- checked that this PR does not duplicate an open PR.

In the Content, I have included 
- relevant unit tests, and integration tests, 
- appropriate docstrings on all functions, structs, and modules, and included relevant documentation.

-->

----
- [x ] I have read and checked the items on the review checklist.


Co-authored-by: Wilson Duan <[email protected]>
  • Loading branch information
bors[bot] and wilsonduan10 committed Jun 27, 2023
2 parents b18af99 + d40474d commit 55ea3fa
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/EnsembleKalmanProcess.jl
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ end
"""
get_ϕ(prior::ParameterDistribution, ekp::EnsembleKalmanProcess)
Returns the unconstrained parameters from all iterations. The outer dimension is given by the number of iterations.
Returns the constrained parameters from all iterations. The outer dimension is given by the number of iterations.
"""
get_ϕ(prior::ParameterDistribution, ekp::EnsembleKalmanProcess) =
transform_unconstrained_to_constrained(prior, get_u(ekp))
Expand Down

0 comments on commit 55ea3fa

Please sign in to comment.