Skip to content

Update general documentation files#398

Merged
joyvelasquez merged 3 commits into
HinodeXRT:mainfrom
joyvelasquez:general-docs-updates
Jul 2, 2026
Merged

Update general documentation files#398
joyvelasquez merged 3 commits into
HinodeXRT:mainfrom
joyvelasquez:general-docs-updates

Conversation

@joyvelasquez

Copy link
Copy Markdown
Contributor

Extracts general documentation updates from PR #367 (XRT DEM Iterative Solver), per review feedback from @namurphy.

Files updated:

  • docs/about_xrt.rst
  • docs/getting_started.rst
  • docs/glossary.rst
  • docs/index.rst

No changes to source code or other documentation.

@joyvelasquez

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@codecov

codecov Bot commented Jul 2, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.34%. Comparing base (315139e) to head (e1e7d6f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #398   +/-   ##
=======================================
  Coverage   87.34%   87.34%           
=======================================
  Files          26       26           
  Lines        1818     1818           
  Branches      106      106           
=======================================
  Hits         1588     1588           
  Misses        184      184           
  Partials       46       46           

☔ View full report in Codecov by Harness.
📢 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.

@joyvelasquez joyvelasquez force-pushed the general-docs-updates branch from 0facb49 to 5483123 Compare July 2, 2026 16:19
@joyvelasquez

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@joyvelasquez joyvelasquez merged commit 7de79d9 into HinodeXRT:main Jul 2, 2026
9 checks passed
@joyvelasquez joyvelasquez deleted the general-docs-updates branch July 2, 2026 16:31
@joyvelasquez joyvelasquez self-assigned this Jul 2, 2026
joyvelasquez added a commit to joyvelasquez/xrtpy that referenced this pull request Jul 2, 2026
* Update general documentation files

* Revert index.rst and glossary.rst - depend on DEM content not yet in main

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
joyvelasquez added a commit that referenced this pull request Jul 6, 2026
* Exclude xrt_dem_iterative from pytest collection until v0.6.0

* [pre-commit.ci] pre-commit autoupdate (#388)

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/python-jsonschema/check-jsonschema: 0.37.0 → 0.37.1](python-jsonschema/check-jsonschema@0.37.0...0.37.1)
- [github.com/codespell-project/codespell: v2.4.1 → v2.4.2](codespell-project/codespell@v2.4.1...v2.4.2)
- [github.com/astral-sh/ruff-pre-commit: v0.15.4 → v0.15.9](astral-sh/ruff-pre-commit@v0.15.4...v0.15.9)
- [github.com/tox-dev/pyproject-fmt: v2.16.2 → v2.21.0](tox-dev/pyproject-fmt@v2.16.2...v2.21.0)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Joy <74623359+joyvelasquez@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#391)

updates:
- [github.com/python-jsonschema/check-jsonschema: 0.37.1 → 0.37.2](python-jsonschema/check-jsonschema@0.37.1...0.37.2)
- [github.com/astral-sh/ruff-pre-commit: v0.15.9 → v0.15.12](astral-sh/ruff-pre-commit@v0.15.9...v0.15.12)
- [github.com/tox-dev/pyproject-fmt: v2.21.0 → v2.21.1](tox-dev/pyproject-fmt@v2.21.0...v2.21.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (#392)

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.15.12 → v0.15.15](astral-sh/ruff-pre-commit@v0.15.12...v0.15.15)
- [github.com/tox-dev/pyproject-fmt: v2.21.1 → v2.23.0](tox-dev/pyproject-fmt@v2.21.1...v2.23.0)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update XRT CCD contamination files (geny, sav) - DB covers through 2026/06/07 (#395)

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>

* Update XRT CCD contamination files (geny, sav) - DB covers through 20260621 (#397)

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>

* Update gallery docs for data processing and instrument response examples (#396)

* Update gallery docs for data processing and instrument response examples

* Add missing __init__.py files for gallery subpackages

* Force the Agg backend and fix the coverage target

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Check the Fido.search calls in temperature_from_filter_ratios.py

* Check the Fido.search calls in deconvolving.py

---------

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update general documentation files (#398)

* Update general documentation files

* Revert index.rst and glossary.rst - depend on DEM content not yet in main

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update conftest, pyproject, and response __init__ with cleanup changes (#399)

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>

* Enable parallel test execution in noxfile (#400)

* Enable parallel test execution in noxfile

* Ignore sphinx-gallery scripts in pytest

---------

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>

* Add Python 3.14 to the test matrix

* Add changelog entry for Python 3.14 support

---------

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
joyvelasquez added a commit to joyvelasquez/xrtpy that referenced this pull request Jul 6, 2026
* Exclude xrt_dem_iterative from pytest collection until v0.6.0

* [pre-commit.ci] pre-commit autoupdate (HinodeXRT#388)

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/python-jsonschema/check-jsonschema: 0.37.0 → 0.37.1](python-jsonschema/check-jsonschema@0.37.0...0.37.1)
- [github.com/codespell-project/codespell: v2.4.1 → v2.4.2](codespell-project/codespell@v2.4.1...v2.4.2)
- [github.com/astral-sh/ruff-pre-commit: v0.15.4 → v0.15.9](astral-sh/ruff-pre-commit@v0.15.4...v0.15.9)
- [github.com/tox-dev/pyproject-fmt: v2.16.2 → v2.21.0](tox-dev/pyproject-fmt@v2.16.2...v2.21.0)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Joy <74623359+joyvelasquez@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (HinodeXRT#391)

updates:
- [github.com/python-jsonschema/check-jsonschema: 0.37.1 → 0.37.2](python-jsonschema/check-jsonschema@0.37.1...0.37.2)
- [github.com/astral-sh/ruff-pre-commit: v0.15.9 → v0.15.12](astral-sh/ruff-pre-commit@v0.15.9...v0.15.12)
- [github.com/tox-dev/pyproject-fmt: v2.21.0 → v2.21.1](tox-dev/pyproject-fmt@v2.21.0...v2.21.1)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* [pre-commit.ci] pre-commit autoupdate (HinodeXRT#392)

* [pre-commit.ci] pre-commit autoupdate

updates:
- [github.com/astral-sh/ruff-pre-commit: v0.15.12 → v0.15.15](astral-sh/ruff-pre-commit@v0.15.12...v0.15.15)
- [github.com/tox-dev/pyproject-fmt: v2.21.1 → v2.23.0](tox-dev/pyproject-fmt@v2.21.1...v2.23.0)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update XRT CCD contamination files (geny, sav) - DB covers through 2026/06/07 (HinodeXRT#395)

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>

* Update XRT CCD contamination files (geny, sav) - DB covers through 20260621 (HinodeXRT#397)

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>

* Update gallery docs for data processing and instrument response examples (HinodeXRT#396)

* Update gallery docs for data processing and instrument response examples

* Add missing __init__.py files for gallery subpackages

* Force the Agg backend and fix the coverage target

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Check the Fido.search calls in temperature_from_filter_ratios.py

* Check the Fido.search calls in deconvolving.py

---------

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update general documentation files (HinodeXRT#398)

* Update general documentation files

* Revert index.rst and glossary.rst - depend on DEM content not yet in main

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

* Update conftest, pyproject, and response __init__ with cleanup changes (HinodeXRT#399)

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>

* Enable parallel test execution in noxfile (HinodeXRT#400)

* Enable parallel test execution in noxfile

* Ignore sphinx-gallery scripts in pytest

---------

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>

* Add Python 3.14 to the test matrix

* Add changelog entry for Python 3.14 support

---------

Co-authored-by: joyvelasquez <joy.velasquez@cfa.harvard>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant