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

Miscellaneous doc string improvements #215

Open
tomdonaldson opened this issue Feb 19, 2020 · 1 comment
Open

Miscellaneous doc string improvements #215

tomdonaldson opened this issue Feb 19, 2020 · 1 comment

Comments

@tomdonaldson
Copy link
Contributor

While implementing a few queries I stumbled across some corrections/improvements that could be made to the in-code documentation. No doubt there are plenty of others, and a thorough review wouldn't be a bad idea, but here is a start:

def search(self, *args, **keys):

  • Replace the reference to a nonexistent 'database' search with a reference to TAP.
  • Says that self.search() is equivalent to self.to_service().search(), but to_service() doesn't exist. It should be just service(), which is a little inconsistent with RegistryResults where table() has been deprecated in favor of to_table().

'Please use se to_table() instead.'

  • Typo in deprecation warning.

def search(

  • Has 2 different descriptions for size argument, neither of which are very clear about what you can/should supply. (This function doc is repeated multiple places in sia.py.)
  • Documents the intersect argument which is not required for SIA services and probably isn't well-supported. The docs should at least have that caveat.

votable : str

  • votable arg is listed as a string but is really a astropy.io.votable.tree.VOTableFile
@bsipocz
Copy link
Member

bsipocz commented Dec 15, 2023

Would be nice to get the docs eventually cleaned up, maybe something for the next release? (This could also go in a bugfix one...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants