Updating and Editing AstroDB Documentation #216
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Added description for get_db_instrument. Added an instruments section on api documentation
Added a code block example for ingesting publications.
fix typo
kelle
reviewed
Dec 2, 2025
kelle
reviewed
Dec 2, 2025
kelle
reviewed
Dec 5, 2025
kelle
reviewed
Dec 5, 2025
kelle
reviewed
Dec 5, 2025
kelle
reviewed
Dec 5, 2025
kelle
reviewed
Dec 5, 2025
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
Co-authored-by: Kelle Cruz <kellecruz@gmail.com>
Contributor
|
The tests not passing are not related to this PR. This is coming along nicely! When you're done, change from Draft to "Ready for review". |
kelle
reviewed
Dec 9, 2025
| Search Object function | ||
| ------------------------- | ||
| The **search_object** function allows you to search for astronomical objects in the database by name or identifier. It returns a list of matching sources along with their details. |
Contributor
There was a problem hiding this comment.
Suggested change
| The **search_object** function allows you to search for astronomical objects in the database by name or identifier. It returns a list of matching sources along with their details. | |
| The **search_object** method allows you to search for astronomical objects in the database by name or identifier. It returns a list of matching sources along with their details. |
kelle
reviewed
Dec 9, 2025
| Inventory Search function | ||
| ------------------------- | ||
| The **inventory_search** function returns all data for an object |
Contributor
There was a problem hiding this comment.
Suggested change
| The **inventory_search** function returns all data for an object | |
| The **inventory_search** method returns all data for an object |
kelle
reviewed
Dec 9, 2025
kelle
reviewed
Dec 9, 2025
kelle
reviewed
Dec 9, 2025
| Exploring the Schema | ||
| ------------------------- | ||
| The database schema is accessible via the **db.metadata** attribute after loading the database. |
Contributor
There was a problem hiding this comment.
Suggested change
| The database schema is accessible via the **db.metadata** attribute after loading the database. | |
| The AstroDB Toolkit makes extensive use of the Astrodbkit package. Astrodbkit provides the Database class and useful methods for exploring the database. | |
| The database schema is accessible via the **db.metadata** attribute after loading the database. |
Contributor
There was a problem hiding this comment.
also link AstrodbKit to to https://astrodbkit.readthedocs.io/en/latest/
Contributor
|
Please make extensive use of the will make an auto-magic link to the API documentation for the find_publication function. Here's the relevant Sphinx documentation: https://www.sphinx-doc.org/en/master/usage/domains/python.html#target-specification |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.