search

sunpy / sunpy-1.0-paper

The SunPy 1.0 Paper Repo
12 stars 21 forks source link

Albert's editing pass #149

Closed ayshih closed 5 years ago

ayshih commented 5 years ago

Nothing too controversial, I believe. I didn't include my edits on the introduction since that's still in flux (see #148). I'll need someone else to remake Figures 1 and 4 for me because I can't actually build the figures on my machine.

ayshih commented 5 years ago

@wtbarnes Thanks for the comments and catching the garbled edits! I added NASEM to the abbreviation table, but we may need to re-balance what's actually included in that table because I think a bunch don't occur often enough to be considered "common", and there are others (e.g., RHESSI or STEREO) that aren't in the table.

wtbarnes commented 5 years ago

Agreed on the abbreviation table. When doing my abbreviation edit, my policy was to put it in the table if we used it more than once in the paper. If there are cases where that's not true, then it is a mistake on my part. There may also be abbreviations that are just not important enough to take up room there.

RHESSI and STEREO are only used in the Map/Timeseries table (I think?) so I did not include them in the abbreviations table.

ayshih commented 5 years ago

RHESSI and STEREO (as well as NoRH, LYRA, EVE, etc.) are mentioned in exactly one other place beyond that Map/TimeSeries table. Even so, they may not be "common" enough to warrant being listed in the abbreviation table.

Conversely, HCC, SPoCA, and TAI are mentioned only once each in the text, and should probably be removed from the abbreviation table.

wtbarnes commented 5 years ago

Ah ok. HCC, SPoCA, and TAI were my mistake. I think it is sensible to remove the infrequently used instrument abbreviations you mentioned as well.