Skip to content

Commit

Permalink
Update changelog and docs to reflect removal of parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
mfisher87 committed Feb 11, 2025
1 parent cbac574 commit 82227a9
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
9 changes: 5 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,11 @@ and this project uses [Semantic Versioning](https://semver.org/spec/v2.0.0.html)
([**@juliacollins**](https://github.com/juliacollins))

### Changed
- **Breaking**: earthaccess will throw an error by default when login credentials are rejected. Pass
`earthaccess.login(..., raise_on_failure=False)` to disable and print a warning
instead. ([#946](https://github.com/nsidc/earthaccess/pull/946))
([**@mfisher87**](https://github.com/mfisher87))
- **Breaking**: earthaccess will now raise an exception when login credentials are
rejected. If you need the old behavior, please use a `try` block.
([#946](https://github.com/nsidc/earthaccess/pull/946))
([**@mfisher87**](https://github.com/mfisher87), [@chuckwondo](https://github.com/chuckwondo),
and [@jhkennedy](https://github.com/jhkennedy))

## [v0.13.0] - 2025-01-28

Expand Down
12 changes: 9 additions & 3 deletions docs/user_guide/backwards-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,12 @@ Our project follows the [SPEC0](https://scientific-python.org/specs/spec-0000/)

### 0.14.0

* `earthaccess.login()` will now raise an exception by default if Earthdata Login rejects credentials.
We recommend you adjust your code to handle this. If you want to disable
this, pass `earthaccess.login(..., raise_on_failure=False)`.
* `earthaccess.login()` will now raise an exception if Earthdata Login rejects credentials.
If you want to ignore errors, which we do not recommend, use a `try` block:

```python
try:
earthaccess.login()
except Exception:
pass
```

0 comments on commit 82227a9

Please sign in to comment.