Skip to content

Commit

Permalink
ENH: Error in contributors guide as well
Browse files Browse the repository at this point in the history
  • Loading branch information
AdamTheisen committed Dec 6, 2023
1 parent 105523a commit ba8b921
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -287,8 +287,8 @@ When adding discovery modules or functions please adhere to the following
* Filenames should just include the name of the organization (arm) or portal (airnow) and no other filler words like get or download
* Functions should follow [get/download]_[org/portal]_[data/other description]. If it is getting data but not downloading a file, it should start with get, like get_asos_data. If it downloads a file, it should start with download. The other description can vary depending on what you are retrieving. Please check out the existing functions for ideas.

Discovery
~~~~~~~~~
IO
~~
Similarly, for the io modules, the names should not have filler and just be the organization or portal name. The functions should clearly indicate what it is doing like read_arm_netcdf instead of read_netcdf if the function is specific to ARM files.

Adding Secrets and Environment Variables
Expand Down

0 comments on commit ba8b921

Please sign in to comment.