astropy / astropy/astroquery

Update ESO docs

Open
#3,491 9 comments 0 reactions 0 assignees View on GitHub
Documentation eso
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

Hey!

I plan to make some updates to the astroquery.eso docs (tagging @juanmcloaiza).

Is it a preference to have the docs in a flat structure page ([as is now](https://astroquery.readthedocs.io/en/latest/eso/eso.html)), or with heierarchy like with [MAST](https://astroquery.readthedocs.io/en/latest/mast/mast.html)? I can see the benefits of having either, particularly for the latter when we add more functionality.

-- Ash

Contributor guide

Open the contributing guide

Research direction

Compare the current ESO page at astroquery.readthedocs.io/en/latest/eso/eso.html with the MAST hierarchy at astroquery.readthedocs.io/en/latest/mast/mast.html. First resolve the preferred documentation structure with the maintainers; done means the ESO docs follow the agreed structure and accurately cover the existing functionality.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.