Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

'Library' list #278

Open
okennedy opened this issue Oct 10, 2023 · 0 comments
Open

'Library' list #278

okennedy opened this issue Oct 10, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers layer-api An issue involving the vizier API layer layer-python An issue involving the Python compatibility code
Milestone

Comments

@okennedy
Copy link
Contributor

What pain point is this feature intended to address? Please describe.
#18, once fully implemented, will spam the Artifacts list with Python libraries and functions.

Describe the solution you'd like
Subdivide the artifacts list into multiple categories. For now, this can be limited to splitting Libraries off from the rest, and maybe de-emphasizing it (e.g., putting it at the bottom of the list).

If we do this, we could also use the 'fields' positions to provide links to documentation. Some thoughts:

  • We could pull out the module's docstring and function list
  • We could see if we could dig up enough metadata to link to the project's main docs page.
  • We could add documentation on standard Vizier components (e.g., Spark Javadocs)
@okennedy okennedy added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers layer-api An issue involving the vizier API layer layer-python An issue involving the Python compatibility code labels Oct 10, 2023
@okennedy okennedy added this to the Version 2.1 milestone Oct 10, 2023
@okennedy okennedy mentioned this issue Nov 11, 2023
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 enhancement New feature or request good first issue Good for newcomers layer-api An issue involving the vizier API layer layer-python An issue involving the Python compatibility code
Projects
None yet
Development

No branches or pull requests

1 participant