Skip to content

Conversation

@dr-rodriguez
Copy link
Collaborator

@dr-rodriguez dr-rodriguez commented Jul 22, 2025

Updating documentation to use the term lookup tables instead of reference tables.

The variable names in the code are left as reference to avoid breaking changes.

@dr-rodriguez dr-rodriguez requested a review from kelle July 22, 2025 20:37
@dr-rodriguez dr-rodriguez self-assigned this Jul 22, 2025
@dr-rodriguez dr-rodriguez added the documentation Improvements or additions to documentation label Jul 22, 2025
@kelle
Copy link
Collaborator

kelle commented Aug 12, 2025

I think we should add a new argument lookup_tables and rename the example in the init.py to LOOKUP_TABLES. I'm ok with keeping the old argument reference_tables for legacy, but both should be usable. If you want this PR to just focus on docs, that's fine, but if we're gonna make the change, might as well make the change!

class Database:
"""Database handler class"""

@deprecated_alias(reference_tables="lookup_tables")
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should make it so you can use either reference_tables or lookup_tables for the parameter, with the former having a deprecation warning.

@codecov
Copy link

codecov bot commented Aug 13, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.37%. Comparing base (24a4749) to head (8f2aeb3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #102   +/-   ##
=======================================
  Coverage   95.36%   95.37%           
=======================================
  Files          10       10           
  Lines        1122     1124    +2     
=======================================
+ Hits         1070     1072    +2     
  Misses         52       52           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@dr-rodriguez dr-rodriguez merged commit 58ba11d into astrodbtoolkit:main Sep 9, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants