New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The gridded package needs a docstring #78

Open

drf5n opened this issue Aug 2, 2023 · 0 comments

drf5n commented Aug 2, 2023 •

edited

Loading

The module docstring is missing from here:

gridded/gridded/__init__.py

Lines 1 to 10 in 794bbee

    
           #!/usr/bin/env python 
        
           __version__ = "0.5.6" 
        
           VALID_SGRID_LOCATIONS = (None, 'center','edge1','edge2','node') 
        
           VALID_UGRID_LOCATIONS = (None, 'node', 'face', 'edge', 'boundary') 
        
           VALID_LOCATIONS = set(VALID_SGRID_LOCATIONS + VALID_UGRID_LOCATIONS)

Maybe copy the one from:

https://github.com/NOAA-ORR-ERD/gridded/blob/794bbee5bd08e7db618be1d7e0034361e2bd8a23/gridded/gridded.py#L3C4-L9

and also point back home to https://github.com/NOAA-ORR-ERD/gridded

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment