Review updates

[spentelow]

Addressed various changes from Marco and Chad's reviews:

• Marco:

  • Changed regex in assert statement in get_weather_data() fxn to allow station numbers that begin with a letter
  • Added group member names explicitly to Contributors section of readme
  • Fixed readme typo ('do' to 'does')
  • Changed code chunk format to be ```python in readme

• Chad:

  • Clarified meaning/format of station_number argument of get_weather_data() function in the usage section of the readme
  • Fixed readme typo ('publically' to 'publicly')
  • Added group member names explicitly to Contributors section of readme
  • Changed error thrown when a year is entered for which there is no station data (removed 'FTP Error' return). Although the suggestion of checking the year/station_id combination entered in the get_weather_data() function against the output table from get_stations_info() is a good one, it has not been implemented. To implement it would mean calling get_stations_info() from within the get_weather_data() function and I think that the loss in performance is not worth the gain in being able to explicitly check the user input. The revised error raised by the function if an year is entered for which there is no data is shown below and, while not ideal, is descriptive enough at this stage.

    > Error generated from NOAA FTP site: 
    > 550 911650-22536-1970.gz: No such file or directory

[codecov[bot]]

Codecov Report

Merging #47 (e8cdb07) into main (4533f35) will not change coverage. The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #47   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            5         5           
  Lines          176       176           
=========================================
  Hits           176       176           

Flag	Coverage Δ
unittests	100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
tests/test_get_weather_data.py	100.00% <ø> (ø)
noaastn/__init__.py	100.00% <100.00%> (ø)
noaastn/noaastn.py	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 1f622d5...e8cdb07. Read the comment docs.