Improving servicetype documentation #410
Conversation
This lists all shorthands listed in SERVICE_TYPE_MAPS, even the legacy ones. Closes: astropy#400. Also, Adding Constraint to rtcons' exported names. That's partly to make it easier for user code to define their own RegTAP constraints, partly to get it documented.
Codecov Report
@@ Coverage Diff @@
## main #410 +/- ##
=======================================
Coverage 79.97% 79.97%
=======================================
Files 52 52
Lines 5972 5972
=======================================
Hits 4776 4776
Misses 1196 1196
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Would you think it would make sense to also mention these in the narrative docs? E.g. here https://pyvo.readthedocs.io/en/latest/registry/index.html#service-discovery?
|
On Thu, Jan 26, 2023 at 09:54:06AM -0800, Brigitta Sipőcz wrote:
Would you think it would make sense to also mention these in the
narrative docs? E.g. here
https://pyvo.readthedocs.io/en/latest/registry/index.html#service-discovery?
While in general, I'd like to nudge people away from using
servicetype constraints in normal data discovery, I give you
that as long as we don't have a better way to say "I want spectra",
say, they will continue to be important. But I'd rather not write
more on this until we see what comes out of bug #399 -- I *suspect*
we will split "image" and "sia"/"sia2" there, and that would inform
us how we'll deal with major version changes in general.
Hence, my suggestion: Merge this, and then let's work on #399.
|
I'm not against this, but we have used it in tutorials, so those materials needs to be updated as well. (Also, I don't have a strong opinion of how much should be done about this, the whole issue about this came up during the NAVO workshop where a user had a bit of a hard time to find out from the docs of what the possible |
👍 |
Improving servicetype documentation
This lists all shorthands listed in SERVICE_TYPE_MAPS, even the legacy ones. Closes: #400.
Also, Adding Constraint to rtcons' exported names. That's partly to make it easier for user code to define their own RegTAP constraints, partly to get it documented.