astropy / astropy/astroquery

DOC: better documentation for the config system

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

Description

We need a more detailed and better documentation, and with lots and lots of examples.

cc @keflavich

Contributor guide

Open the contributing guide

Research direction

Start by locating the config system implementation and any existing configuration documentation in the repository; no file, test, or entry point is named in the issue. Done means the configuration behavior is documented in greater detail with many examples, but the required scope and examples should be confirmed with the maintainer.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.