astropy / astropy/astroquery

ESO documentation

Open
#943 6 comments 0 reactions 0 assignees View on GitHub
Documentation eso package-novice
Dominant language
Python
Stars
791
Forks
451
Avg merge
1d 3h
Merged PRs (30d)
4

Description

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.

Contributor guide

Open the contributing guide

Research direction

Start by locating the ESO documentation and the tests containing its existing examples. Use those examples as the basis for expanded documentation, adding a few narrative sentences that explain how to use them. Done means the ESO documentation contains more practical examples and explanatory context.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.