astrodbtoolkit / astrodbtoolkit/astrodb_utils

Improve docs on REFERENCE TABLES

Open
#173 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Python
Stars
0
Forks
10
PR merge metrics
No merged PRs in 30d

Description

The order in which tables are listed in the ReferenceTables matters! Eg., you cant list Instruments before Telescopes.

also, should we consider renaming these/thinking more carefully about our language? We've started calling the tables List. I like calling them "Lookup Tables" rather than "reference" tables. The name "reference" is also confused with Publications.

Contributor guide

No contributing guide indexed for this repository

Research direction

No file or test is named. Start by locating the documentation and code references for ReferenceTables and the current List names; trace where table ordering is described or enforced. Done should clearly document the ordering constraint and settle or explicitly record the terminology for these tables without confusing them with Publications.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.