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.

Sign up for GitHub

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

Jump to bottom

Update diagnostics docs #743

Merged
merged 2 commits into from
Aug 30, 2024
Merged

Update diagnostics docs #743

merged 2 commits into from
Aug 30, 2024

Conversation

AlexisRenchon
Copy link
Member

@AlexisRenchon AlexisRenchon commented Aug 29, 2024 •
edited
Loading

Commit 1:

  • Diagnostic menu order change (For users, For developers, Available diagnostics)
  • For users: example of using the @diagnostic_compute macro
  • For users: julia snippet, no longer multiple 1., last snippet was wrong
  • For developers: julia snippet, various bug fixes (e.g., _ escaped with _)
  • For developers: example of using the @diagnostic_compute macro
  • For developers: explained what @with_errors do, removed old version

Commit 2:

  • Adds a test for ALL_DIAGNOSTICS (check if it is a Dict and if its length change after adding a diagnostic variable)

https://clima.github.io/ClimaLand.jl/previews/PR743/

@AlexisRenchon AlexisRenchon force-pushed the ar/diagnostics_docs_update branch 3 times, most recently from 4be6996 to 7bf2a6c Compare August 29, 2024 21:45
@AlexisRenchon
Update diagnostics documentation
2954b39 
- For clarity, the diagnostics documentation menu order was updated,
starting with For users, then For developers, then available
diagnostics.
- For users and For developers page updated with @diagnostic_compute
macro, julia snippet, and various bug fixes.
- For developers: @with_errors macro updated.
@AlexisRenchon AlexisRenchon force-pushed the ar/diagnostics_docs_update branch from 7bf2a6c to 097066e Compare August 29, 2024 21:51
@AlexisRenchon AlexisRenchon marked this pull request as ready for review August 29, 2024 21:52
@AlexisRenchon AlexisRenchon requested a review from Sbozzolo August 29, 2024 21:52
@AlexisRenchon AlexisRenchon force-pushed the ar/diagnostics_docs_update branch from 7f884e9 to cc7b705 Compare August 30, 2024 16:57
Sbozzolo
Sbozzolo reviewed Aug 30, 2024
View reviewed changes
docs/src/diagnostics/developers_diagnostics.md Outdated

```Julia
@diagnostic\_compute "albedo" BucketModel p.bucket.α\_sfc
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
@diagnostic\_compute "albedo" BucketModel p.bucket.α\_sfc
@diagnostic_compute "albedo" BucketModel p.bucket.α\_sfc

@AlexisRenchon AlexisRenchon force-pushed the ar/diagnostics_docs_update branch from cc7b705 to f4c1702 Compare August 30, 2024 18:01
@AlexisRenchon AlexisRenchon mentioned this pull request Aug 30, 2024
Closed
9 tasks
@AlexisRenchon
This commit adds a diagnostics test for ALL_DIAGNOSTICS
d0def77 
In this commit, we check if ALL_DIAGNOSTICS isa Dict, check if its
length is 0. Then we add a diagnostic variable, and check if its new
length is 1.
@AlexisRenchon AlexisRenchon force-pushed the ar/diagnostics_docs_update branch from f4c1702 to d0def77 Compare August 30, 2024 19:04
@AlexisRenchon AlexisRenchon merged commit a35f55c into main Aug 30, 2024
8 of 9 checks passed
@AlexisRenchon AlexisRenchon deleted the ar/diagnostics_docs_update branch October 21, 2024 18:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Sbozzolo Sbozzolo Sbozzolo approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AlexisRenchon @Sbozzolo