Possible docs typo #23
Merged
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
|
Thank you :) I'll merge this once you caught all the other typos |
Sbozzolo
approved these changes
May 21, 2024
docs/src/user_guide.md
Outdated
| something every 10 steps, and output it the average every 100 iterations. | ||
| `schedule` functions are powerful, so there is an entire section dedicated to | ||
| them below. `compute_schedule_func` and `output_schedule_func` are likely | ||
| going to the same unless there are temporal reductions. | ||
| - an `output_writer`, an object that knows how what to do with the output. | ||
| going to the same (? same what ? output ?) unless there are temporal reductions. |
There was a problem hiding this comment.
Suggested change
| going to the same (? same what ? output ?) unless there are temporal reductions. | |
| going to be the same unless there are temporal reductions. |
docs/src/user_guide.md
Outdated
| @@ -137,7 +136,7 @@ function compute_if_larger_than100(integrator) | |||
| end | |||
| ``` | |||
|
|
|||
| Strictly speaking, schedules do not have to functions, but callable objects. For | |||
| Strictly speaking, schedules do not have to (? be ?) functions, but callable objects. For | |||
There was a problem hiding this comment.
Suggested change
| Strictly speaking, schedules do not have to (? be ?) functions, but callable objects. For | |
| Strictly speaking, schedules do not have to be functions, but callable objects. For |
AlexisRenchon
force-pushed
the
ar/possible_typos
branch
from
69a2fa8 to
19ac5f4
Compare
AlexisRenchon
commented
May 21, 2024
docs/src/developer_guide.md
Outdated
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| This page provides additional documentation on abstractions to use | |||
| `ClimaDiagnostics`. Before reading this page, make sure you are familiar with | |||
| the terminology. You know to know what a [`DiagnosticVariable`](@ref ClimaDiagnostics.DiagnosticVariables.DiagnosticVariable) and a | |||
| the terminology. You need to know what a [`DiagnosticVariable`](@ref ClimaDiagnostics.DiagnosticVariables.DiagnosticVariable) and a | |||
| [`ScheduledDiagnostic`](@ref ClimaDiagnostics.ScheduledDiagnostics.ScheduledDiagnostic) are. | |||
|
|
|||
| There are three components needed to add support for `ClimaDiagnostics.jl` in your package. | |||
There was a problem hiding this comment.
@Sbozzolo Here, we say "three components", but we then only list two. (or maybe I am missing something?) - I think maybe 1. should be DiagnosticVariable?
There was a problem hiding this comment.
You are right. It's 2. I guess I changed my mind halfway through.
There was a few typo in the documentation. This PR fixed those typo.
AlexisRenchon
force-pushed
the
ar/possible_typos
branch
from
0328cdd to
79afe02
Compare
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.
Possible typo in the docs
Purpose
To-do
Content