-
-
Notifications
You must be signed in to change notification settings - Fork 388
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
Adding error handling examples to mast docs #2736
Adding error handling examples to mast docs #2736
Conversation
Codecov Report
@@ Coverage Diff @@
## main #2736 +/- ##
==========================================
+ Coverage 65.87% 66.04% +0.17%
==========================================
Files 233 233
Lines 17904 17927 +23
==========================================
+ Hits 11794 11840 +46
+ Misses 6110 6087 -23 see 3 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some small edits to existing examples. I suggest removing one of the examples entirely, but feel free to keep it if you feel like it's justifiable. Good work!
@bsipocz I think this is ready to merge. Let me know if you have any other suggestions for this. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All the examples cause test failures as the tracebacks are not properly added to the docs. I'll just quickly push a commit and fix it. I'll also rebase to be sure we're all good as there have been a few other PRs since this was branched out, that modified this documentation page.
For the next time, I would suggest to run the remote tests until they are all clean (for this particular case pytest docs/mast -R
)
docs/mast/mast.rst
Outdated
|
||
.. doctest-remote-data:: | ||
|
||
>>> obs_table = Observations.query_object("M8",".02 deg") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This produces a test failure as the error is not exactly copy pasted.
8193499
to
1f10a03
Compare
@jaymedina - the following isn't issue the warning any more, so I also removed that as part of this PR to make sure all the docs is passing:
|
Thanks @mstcyr2! |
Error handling examples to show users how to avoid/fix possible input-based errors.