review: mikapfl#1
Open
mikapfl wants to merge 1 commit into
Open
Conversation
mikapfl
commented
May 22, 2026
| "The REF API is documented with an [OpenAPI](https://www.openapis.org) schema.\n", | ||
| "You can browse the interactive docs at <https://api.climate-ref.org/docs>.\n", | ||
| "\n", | ||
| "The `climate_ref_client` package is *generated* from that schema (see `scripts/generate_client.sh`). \n", |
Author
There was a problem hiding this comment.
I think this is not the right place to document the technical details of how the client package is built.
mikapfl
commented
May 22, 2026
| "result = diagnostics_list_metric_values.sync(\n", | ||
| " provider_slug=\"esmvaltool\",\n", | ||
| " diagnostic_slug=\"climate-at-global-warming-levels\",\n", | ||
| " value_type=MetricValueType.SCALAR,\n", |
Author
There was a problem hiding this comment.
I think it is nicer to show a concrete example, a scientist is likely interested in a specific metric, not in the first metric which has results
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Great start! I like the introduction to core concepts and I think it is good that it is so hands-on.
I flagged some rough edges in the code (not really for merging, mostly, but as a way to add comments in the notebooks).
Also, I'm wondering if we could taylor it even more to what people are likely doing:
It didn't run comfortably on binder for me, notebooks 1 and 2 were fine, but at the end of 3, binder crashed for me and I could never start 4. I then switched to local.