astropy / astropy/pyvo

Documentation: expand user guide on asynchronous queries

Open
#209 1 comment 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Python
Stars
88
Forks
64
Avg merge
38m
Merged PRs (30d)
1

Description

Some items are missing from the user guide for Jobs (async queries).

- the `run_async` which does `run`, `wait` and `fetch_result`
- for a very large query result, it can be better to use wget or curl to fetch the result outside of your python session
- when using in a notebook, it can be helpful to print the job url and open that in a separate web browser tab. That result shows more details of what is happening than what `pyvo.dal.TAPService` provides
- may want to note that `astropy.io.votable` has performance issues when reading in a large result
- some services truncate their synchronous results but not the async ones. For this reason, NAVO has been recommending users to use `run_async` even for small query results.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the user guide section for Jobs (async queries) and review how `run_async`, `pyvo.dal.TAPService`, and `astropy.io.votable` are currently described. Expand it to cover the listed workflow, large-result downloads, notebook job URLs, parsing performance, and synchronous-result truncation; done means each requested item is clearly documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.