Skip to content

Add helpful hint error message if optional dependencies not yet installed. - #1656

Open
Sevans711 wants to merge 3 commits into
sevans/tests-for-optional-depsfrom
sevans/_raise_hint_if_optional_deps_missing
Open

Add helpful hint error message if optional dependencies not yet installed.#1656
Sevans711 wants to merge 3 commits into
sevans/tests-for-optional-depsfrom
sevans/_raise_hint_if_optional_deps_missing

Conversation

@Sevans711

Copy link
Copy Markdown
Collaborator

Addresses part of #1224 #1225 but does not fully close them.

Overview

Adds _raise_hint_if_optional_deps_missing which raises helpful hint upon trying but failing to import optional dependencies due to them not yet being installed.

PR Checklist

General

  • An issue is created and linked
  • Added appropriate labels (if your uxarray repo permissions allow it)
  • Filled out Overview and Expected Usage (if applicable) sections

Testing & Benchmarking

  • Adequate tests are created if there is new functionality
  • Tests are not too basic (such as simply calling a function and nothing else)
  • Tests cover all major paths in your new functions
  • [N/A] If this PR could affect performance, ran ASV benchmarks and confirmed they show expected behavior (add a new benchmark if necessary)

Documentation

  • Docstrings have been added to all new functions
  • Docstrings have been updated with any function changes
  • [N/A] User (public) functions have been added to docs/api.rst
  • Internal (private) function names start with an underscore (_)

AI Disclosure

AI Usage: GitHub Copilot inline code suggestions, some discussion with Claude.

  • I take responsibility for all AI-generated content in my PR.
  • I have tested all AI-generated content in my PR.

@Sevans711 Sevans711 added the dependencies Pull requests that update a dependency file label Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant