Skip to content
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.

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

Query docstring #212

Merged
merged 4 commits into from
Jun 25, 2021
Merged

Query docstring #212

merged 4 commits into from
Jun 25, 2021

Conversation

whyjz
Copy link
Contributor

@whyjz whyjz commented Jun 25, 2021

Hi - this is for the discussion in #207. I added a few lines to the Query docstring so users can get a bit more information about the arguments. I do not plan to remove the files argument because maybe we will need it someday in the future, as @JessicaS11 mentioned from that issue.

P.S. There are 4 commits in total, but the first 3 of them are actually to revert my previous commit (see #171) that is not going to be merged.

@codecov-commenter
Copy link

Codecov Report

Merging #212 (f8d5441) into development (1e1f52f) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           development     #212   +/-   ##
============================================
  Coverage        55.63%   55.63%           
============================================
  Files               20       20           
  Lines             1517     1517           
  Branches           316      316           
============================================
  Hits               844      844           
  Misses             616      616           
  Partials            57       57           
Impacted Files Coverage Δ
icepyx/core/query.py 41.70% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1e1f52f...f8d5441. Read the comment docs.

@JessicaS11
Copy link
Member

Thanks for these updates, @whyjz!

@JessicaS11 JessicaS11 merged commit 31ba438 into icesat2py:development Jun 25, 2021
JessicaS11 added a commit that referenced this pull request Sep 30, 2021
* Add research notice to readme (#206)
* Update query docstring (#212)
* action to automatically update uml diagrams (#208)
* switch to svg
* update docs with new uml diagrams. Add visualization class to components list
* update action trigger to after approved pull request reviews
* update variable names for clarity and in line with common usage (#211)
  * change 'dataset' to 'product' in core and test code
  * update 'source' input parameter to 'path' in variables module (part of a not-yet-implemented feature).
* tests that require an active NSIDC Earthdata session (#209)
  * NOTE: using the fixture to successfully start a session can be considered the test
* check errors raised by empty query object from bounding box split in openaltimetry visualization (#220)
* updated product_summary_info function to latest fields returned by CMR (product_id --> title) (#218)
* traffic/downloads statistics updates and limit traffic action to parent repo (#221)
* GitHub traffic auto-update to not run traffic action on forks.
* remove extra code block from example notebook (#225)
* populate v0.4.1 changelog and add to index (#226)

Co-authored-by: Yo Yehudi <yochannah@gmail.com>
Co-authored-by: Whyjay Zheng <wz278@cornell.edu>
Co-authored-by: Romina Piunno <romina.piunno@gmail.com>
Co-authored-by: Tian Li <45267156+icetianli@users.noreply.github.com>
Co-authored-by: JP Swinski <jp.swinski@nasa.gov>
JessicaS11 pushed a commit that referenced this pull request Dec 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants