search

astropy / astroquery

Functions and classes to access online data resources. Maintainers: @keflavich and @bsipocz and @ceb8
http://astroquery.readthedocs.org/en/latest/
BSD 3-Clause "New" or "Revised" License
706 stars 400 forks source link

ESO documentation #943

Open bsipocz opened 7 years ago

bsipocz commented 7 years ago

The current ESO documentation is rather sparse, it needs more examples, even our limited remote testing do more.

This can be addressed by someone new to the package, first approach is to copy the examples from the tests and write a few narrative sentences.

Himanshu-Garg commented 5 years ago

i am new to astropy, so can you pls elaborate a little what we have to do here

bsipocz commented 5 years ago

@Himanshu-Garg - if you go to the docs page, not all the methods are documented with an example: https://astroquery.readthedocs.io/en/latest/eso/eso.html (vs. https://astroquery.readthedocs.io/en/latest/api/astroquery.eso.EsoClass.html#astroquery.eso.EsoClass)

On the other hand we do have tests that could be used as a starting point for more examples in the docs.

Also, while we're at it this module can be a good place to start adding doctesting to the docs. This would require though to add the # doctest: +REMOTE_DATA at the end of each line that relies on internet connection (until we finally have a directive mentioned in https://github.com/astropy/pytest-doctestplus/issues/2). This is ugly, but would very valuable.

kakirastern commented 5 years ago

Hi @Himanshu-Garg, are you working on the issue? I am planning on doing some work on #322 and this issue might be related to that one. It would be great if I could have a go of this one too in preparation the new ESO service, that is if you haven't started on a PR yet... I know the work could get "ugly" (in @bsipocz's word), but I don't mind doing that.

Himanshu-Garg commented 5 years ago

Sure, you can do it...

kakirastern commented 5 years ago

@Himanshu-Garg Thanks for letting me know!

dinazavyr commented 4 years ago

@bsipocz Hi, I'm an Outreachy applicant and would like to work on this one. Can I work on this? And, I have a question, what is the organization system of source files? If I want to find file related to ESO documentation, where I can find it? I think I need to go to docs folder and after that where I need to look for source code? Thanks. Dina Saparbaeva