weather-panel.github.io icon indicating copy to clipboard operation
weather-panel.github.io copied to clipboard

JOSE Review - comments on Introduction

Open kls2177 opened this issue 2 years ago • 3 comments

Nicely laid out. Just a few comments:

  • The link to the IPCC report should be updated to AR6 (I realize that AR5 was the most up-to-date when this review started). You can link to the entire WGI landing page rather than a specific chapter. You may also consider adding a link to the WGII report (not just WGI) as this may be more relevant to your readers. Although, I agree that some WGI background knowledge is essential.
  • For the region data section, do you want to add an example, e.g. census tract.
  • Mathematical notation: as a climate scientist, I would prefer that T not be used as the dummy variable name as it may make the reader think of temperature. What about X? I haven't read the entire tutorial yet, so maybe the choice will make more sense later.

kls2177 avatar Jun 06 '23 20:06 kls2177

@kls2177 Thank you for the comments, across all of our sections! I have edited the Introduction under this commit:https://github.com/atrisovic/weather-panel.github.io/commit/2cc9796484c38addc214080081f0c20dc039e908

Responding to your comments individually:

  • Thanks for the note about AR6-- we definitely want to keep this up to date. I've linked to the AR6 WGI and WGII chapters, but I also included a comment pointing readers to WGI Chapter 1, since that provides the background information we think readers will particularly benefit from at this point in the tutorial.
  • I added examples for each region type: "political units (e.g. municipalities), statistical units (e.g., census tracts), and jurisdictions (e.g., educational districts)".
  • I switched this to X. It's somewhat common in the climate-economics field to use T as a proxy for any weather variable, since temperature is often the one that is of most interest, but I can see the potential for confusion. I clarified that we will use T and P for temperature and precip. elsewhere in the tutorial. We will also update the comments on functional forms to use X rather than T as our generic variable.

jrising avatar Jul 05 '23 19:07 jrising

@jrising

Great updates! Just a general comment about the table of contents, are you going to capitalize all words or just the first word for chapter titles and section titles. This is a minor issue, but right now there is an inconsistency across the chapters.

kls2177 avatar Jan 30 '24 19:01 kls2177

@kls2177 Good point. I now changed all of the table of contents headings and within-section headings to use first-word-style capitalization.

Here's the relevant commit: ad0f46dc3280916ab0146c8302b1a825e5fb0702.

jrising avatar Mar 04 '24 03:03 jrising