Skip to content

Commit

Permalink
minor edits to language and badges (#494)
Browse files Browse the repository at this point in the history
  • Loading branch information
JessicaS11 authored May 16, 2024
1 parent a615438 commit cc02758
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Current development version (development branch): |Docs Status dev| |Travis dev
.. |Pypi install| image:: https://badge.fury.io/py/icepyx.svg
:target: https://pypi.org/project/icepyx

.. |Contributors| image:: https://img.shields.io/badge/all_contributors-34-orange.svg?style=flat-square
.. |Contributors| image:: https://img.shields.io/badge/all_contributors-40-orange.svg?style=flat-square
:alt: All Contributors
:target: https://github.com/icesat2py/icepyx/blob/main/CONTRIBUTORS.rst

Expand Down
5 changes: 3 additions & 2 deletions doc/source/contributing/icepyx_internals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@ Authentication
--------------
Authentication in icepyx is handled using a Mixin class. A Mixin class is a class
which defines functionality that may be desired by multiple other classes within
a library. For example, at this time both the Query and Variables classes need
a library.
For example, at this time the Query, Variables, and Read classes need
to be able to authenticate. Instead of defining the same properties and
functionality twice, icepyx has an EarthdataAuthMixin class that is inherited
by both modules.
by any modules that need an Earthdata login.

**Property Access**

Expand Down
3 changes: 2 additions & 1 deletion doc/source/contributing/release_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@ This will involve submitting a new PR to development with whatever debugging cha
Once merged into development, any changes will automatically be reflected in this step's PR, and the tests will rerun automatically.

With an approving review and passed tests in hand, you're ready to push the new release!
Unlike when you merge new features into ``development`` with a squash merge, for this step you'll want to use a plain old merge.
Unlike when you merge new features into ``development`` with a squash merge,
for this step you'll want to use a plain old merg (the button says "Create a Merge Commit").
This makes it easy to keep ``development`` and ``main`` even instead of diverging due to a series of merge commits.
`This website <https://goiabada.blog/git-tricks-keeping-branches-even-7ddc8647d1f3>`_ does a great job explaining the how and why of not using a squash merge here.

Expand Down
2 changes: 1 addition & 1 deletion doc/source/example_notebooks/IS2_data_access.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -472,7 +472,7 @@
"### Log in to NASA Earthdata\n",
"When downloading data from NSIDC, all users must login using a valid (free) Earthdata account. The process of authenticating is handled by icepyx by creating and handling the required authentication to interface with the data at the DAAC (including ordering and download). Authentication is completed as login-protected features are accessed. In order to allow icepyx to login for us we still have to make sure that we have made our Earthdata credentials available for icepyx to find.\n",
"\n",
"There are multiple ways to provide your Earthdata credentials via icepyx. Behind the scenes, icepyx is using the [earthaccess library](https://nsidc.github.io/earthaccess/). The [earthaccess documentation](https://nsidc.github.io/earthaccess/tutorials/restricted-datasets/#auth) automatically tries three primary mechanisms for logging in, all of which are supported by icepyx:\n",
"There are multiple ways to provide your Earthdata credentials via icepyx. Behind the scenes, icepyx is using the [earthaccess library](https://nsidc.github.io/earthaccess/). The [earthaccess documentation](https://earthaccess.readthedocs.io/en/latest/tutorials/getting-started/#auth) automatically tries three primary mechanisms for logging in, all of which are supported by icepyx:\n",
"- with `EARTHDATA_USERNAME` and `EARTHDATA_PASSWORD` environment variables (these are the same as the ones you might have set for icepyx previously)\n",
"- through an interactive, in-notebook login (used below); passwords are not shown plain text with this option\n",
"- with stored credentials in a .netrc file (not recommended for security reasons)"
Expand Down

0 comments on commit cc02758

Please sign in to comment.