raise error for use of catalog in Read

icesat2py / icepyx

Python tools for obtaining and working with ICESat-2 data

https://icepyx.readthedocs.io/en/latest/

BSD 3-Clause "New" or "Revised" License

203 stars 101 forks source link

raise error for use of catalog in Read #446

Closed rwegener2 closed 10 months ago

rwegener2 commented 10 months ago

What was done

An error is raised if a user tries to use the catalog argument in the Read module. I should have included this Error as part of #438, so this PR amends that mistake.

How it was done

An error was created for the use of depreciated functionality and added to the Read module. It will be raised if the user tries to use the catalog argument.

How it can be tested

import icepyx as ipx

ipx.Read(catalog='my/catalog')

raises a DepreciationError

github-actions[bot] commented 10 months ago

:point_left: Launch a binder notebook on this branch for commit 3e10d48800c8a389e364588c67a153064d227d0f

I will automatically update this comment whenever this PR is modified

:point_left: Launch a binder notebook on this branch for commit dd293692c308cf6466b1eacdbda8f834a8d19e38

rwegener2 commented 10 months ago

Shoot I've struggled with the spelling of "deprecation" in the past and I really thought I checked that. Honestly it is finally hitting me that I really do say "depreciation" in my head, so I guess it's less of a spelling issue and actually an "I wasn't using the correct word" problem. hide-embarrassed

Sorry about that, and thanks for catching it. This time I promise I'm storing this lesson in long term memory 🙂