Updating docstrings so that sphinx will build the documentation.

[drewoldag]

Small edits to docstrings:

• whitespace
• type hints

Autoapi was trying and failing to import _version.py. I was unable to instruct it to ignore that file, so instead I have suppressed that warning. Which may or may not be a great thing.

[review-notebook-app]

Check out this pull request on 

See visual diffs & provide feedback on Jupyter Notebooks.

---

Powered by ReviewNB

[Copilot]

Pull request overview

This PR updates docstrings to improve Sphinx documentation generation. The changes focus on correcting type hints and formatting docstrings to comply with Sphinx/NumPy documentation standards.

• Updates type hints in docstrings to use more precise Python module references (e.g., pathlib.Path, collections.abc.Callable)
• Improves docstring formatting with proper section headers (Note, Examples) and indentation for nested lists
• Suppresses autoapi import warnings in Sphinx configuration and removes -W (warnings-as-errors) flag from pre-commit hooks to allow documentation to build despite import issues with _version.py

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/hyrax/pytorch_ignite.py	Updated type hints in docstrings to use full module paths for dataset and Engine types
src/hyrax/plugin_utils.py	Updated type hints from generic "function" and "str" to more precise collections.abc.Callable and pathlib.Path
src/hyrax/model_exporters.py	Updated type hints from "NumPy array" and "Path" to np.ndarray and pathlib.Path
src/hyrax/data_sets/random/hyrax_random_dataset.py	Fixed indentation and formatting for nested list items in docstrings
src/hyrax/data_sets/hyrax_csv_dataset.py	Improved documentation structure with proper Note and Examples sections using reST formatting
docs/pre_executed/hyraxql_iterable_demo.ipynb	Removed notebook file (no longer needed or referenced in docs)
docs/conf.py	Added suppression of autoapi import resolution warnings
.pre-commit-config.yaml	Removed -W flag to allow docs to build with warnings instead of treating them as errors

[Copilot]

The type hint format "pytorch-ignite.Engine" is non-standard and may not be recognized by Sphinx or static type checkers. It should be "ignite.engine.Engine" or just "Engine" (since Engine is already imported from ignite.engine at the top of the file).

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 55.28%. Comparing base (bda3e28) to head (d4236ad).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #581   +/-   ##
=======================================
  Coverage   55.28%   55.28%           
=======================================
  Files          53       53           
  Lines        5256     5256           
=======================================
  Hits         2906     2906           
  Misses       2350     2350           

☔ 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.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[mtauraso]

Minor nit we probably want to turn back on "-W" since it protects us from broken internal links.

Otherwise this looks reasonable.

[github-actions]

Before [bda3e28] <v0.6.9>	After [678ab9e]	Ratio	Benchmark (Parameter)
1.68±0.01s	1.82±0.04s	1.08	benchmarks.time_train_help
1.68±0.03s	1.74±0.03s	1.04	benchmarks.time_umap_help
1.68±0.05s	1.73±0.04s	1.03	benchmarks.time_lookup_help
1.70±0.05s	1.75±0.04s	1.03	benchmarks.time_prepare_help
1.70±0.02s	1.74±0.02s	1.03	benchmarks.time_visualize_help
507±10ms	523±8ms	1.03	vector_db_benchmarks.VectorDBInsertBenchmarks.time_load_vector_db(256, 'chromadb')
8.36±0.1ms	8.63±0.3ms	1.03	vector_db_benchmarks.VectorDBSearchBenchmarks.time_search_by_vector_many_shards(128, 'chromadb')
1.70±0.06s	1.72±0.06s	1.02	benchmarks.time_infer_help
32.0±0.07ms	32.5±0.2ms	1.02	benchmarks.time_nb_obj_construct
1.69±0.05s	1.72±0.05s	1.02	benchmarks.time_rebuild_manifest_help

Click here to view all benchmarks.