Skip to content

Commit

Permalink
ENH: Adding documentation for IO naming convention as well.
Browse files Browse the repository at this point in the history
  • Loading branch information
AdamTheisen committed Oct 13, 2023
1 parent 387b207 commit e983b15
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -287,6 +287,9 @@ 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
~~~~~~~~~
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 e983b15

Please sign in to comment.