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

JSOCClient docs are out of date/innacurate #4619

Open
wtbarnes opened this issue Nov 2, 2020 · 4 comments
Open

JSOCClient docs are out of date/innacurate #4619

wtbarnes opened this issue Nov 2, 2020 · 4 comments
Labels
Documentation Affects the documentation Effort Low Requires a small time investment Good First Issue The best issues for new people to tackle! net Affects the net submodule Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required

Comments

@wtbarnes
Copy link
Member

wtbarnes commented Nov 2, 2020

In the JSOCClient docstring, it says that you must wait for your request status to be 0 before downloading the requested files. I don't think this is accurate. I've downloaded all requested files when the status of my request was 2 (though I'm not sure what this status code actually indicates).

Additionally, the wait method does not exist on whatever is returned from JSOCClient.get_request().

This example code is all marked as DOCTEST: SKIP (for good and obvious reasons) so I don't know when the last time this was actually tested.

@wtbarnes wtbarnes added Documentation Affects the documentation net Affects the net submodule labels Nov 2, 2020
@nabobalis nabobalis added Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required Effort Low Requires a small time investment Good First Issue The best issues for new people to tackle! labels Jan 27, 2023
@Himanshu-Vishwas

This comment was marked as outdated.

@nabobalis

This comment was marked as outdated.

@Himanshu-Vishwas

This comment was marked as outdated.

@jayantbhakar
Copy link

jayantbhakar commented Apr 4, 2023

I have gone through the code of drms Client module to see what the status codes mean and I found the following:
_status_code_ok = 0
_status_code_notfound = 6
_status_codes_pending = [1, 2, _status_code_notfound]
_status_codes_ok_or_pending = [_status_code_ok] + _status_codes_pending

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Affects the documentation Effort Low Requires a small time investment Good First Issue The best issues for new people to tackle! net Affects the net submodule Package Novice Requires little knowledge of the internal structure of SunPy Priority Low Slow action required
Projects
None yet
Development

No branches or pull requests

4 participants