Skip to content

I1328 mkdocs additional updates#1330

Merged
ubdbra001 merged 2 commits intoAFM-SPM:mainfrom
ubdbra001:i1328-mkdocs-additional-updates
Apr 8, 2026
Merged

I1328 mkdocs additional updates#1330
ubdbra001 merged 2 commits intoAFM-SPM:mainfrom
ubdbra001:i1328-mkdocs-additional-updates

Conversation

@ubdbra001
Copy link
Copy Markdown
Collaborator

@ubdbra001 ubdbra001 commented Apr 8, 2026

TopoStats Pull Requests

Please provide a descriptive summary of the changes your Pull Request introduces.

The Software Development section of
the Contributing Guidelines may be useful if you are unfamiliar with linting, pre-commit, docstrings and testing.

NB - This header should be replaced with the description but please complete the below checklist or a short
description of why a particular item is not relevant.


Before submitting a Pull Request please check the following.

  • Existing tests pass.
  • Documentation has been updated and builds. Remember to update as required...
    • docs/usage/configuration.md
    • docs/usage/data_dictionary.md
    • docs/usage/advanced.md and new pages it should link to.
  • Pre-commit checks pass.
  • New functions/methods have typehints and docstrings.
  • New functions/methods have tests which check the intended behaviour is correct.

Optional

topostats/default_config.yaml

If adding options to topostats/default_config.yaml please ensure.

  • There is a comment adjacent to the option explaining what it is and the valid values.
  • A check is made in topostats/validation.py to ensure entries are valid.
  • Add the option to the relevant sub-parser in topostats/entry_point.py.

@ubdbra001 ubdbra001 merged commit 76057fe into AFM-SPM:main Apr 8, 2026
5 of 7 checks passed
@codecov
Copy link
Copy Markdown

codecov bot commented Apr 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.98%. Comparing base (950844a) to head (4e88c86).
⚠️ Report is 10 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1330   +/-   ##
=======================================
  Coverage   87.97%   87.98%           
=======================================
  Files          31       31           
  Lines        6039     6026   -13     
=======================================
- Hits         5313     5302   -11     
+ Misses        726      724    -2     

☔ 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.

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