search

DOI-USGS / dataretrieval-python

Python package for retrieving water data from USGS or the multi-agency Water Quality Portal
https://doi-usgs.github.io/dataretrieval-python/
Other
165 stars 41 forks source link

Add warning message to WQP functions #132

Closed ehinman closed 9 months ago

ehinman commented 9 months ago

I created a new function containing the warning message for the upcoming 3.0 profiles in wqp.py. I wasn't quite sure which type of warning we wanted, so I kept the default. I started with the message as a global variable in wqp.py, but then opted to make the warning an internal function. Let me know if another method is preferred (e.g. do we want to read in the txt or...?).

Tagging @lstanish-usgs so she knows this is in the works!

ehinman commented 9 months ago

Thanks for the feedback @thodson-usgs and @lstanish-usgs. Please let me know if the changes I just made are sufficient. I was reading here that adding [!WARNING] makes a nice warning box in GitHub, but I'm unsure what it looks like in practice.

thodson-usgs commented 9 months ago

From https://gist.github.com/cseeman/8f3bfaec084c5c4259626ddd9e516c61

:warning: This is a warning

:warning: This is a warning

And you can see the effect by clicking "Preview" in the top left of the editor: image