Skip to content

AFMReader refactor update - #1385

Draft
ahobbs7 wants to merge 3 commits into
mainfrom
ahobbs7/afmreader-refactor-update
Draft

AFMReader refactor update#1385
ahobbs7 wants to merge 3 commits into
mainfrom
ahobbs7/afmreader-refactor-update

Conversation

@ahobbs7

@ahobbs7 ahobbs7 commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator

Updates the loading of AFM files to expect an AFMLoad object from AFMReader rather than the previously returned tuple or dict object.

Note: this pull request should not be merged until the pull request for AFMReader has been merged into main.

  • Existing tests pass (some tests have been updated to align with new topostats).
  • Documentation has been updated and builds. (No changes necessary)
    • docs/usage/configuration.md
    • docs/usage/data_dictionary.md
    • docs/usage/advanced.md and new pages it should link to.
  • Pre-commit checks pass.
    No new functions or methods so the following or not necessary
  • New functions/methods have typehints and docstrings.
  • New functions/methods have tests which check the intended behaviour is correct.

@ahobbs7

ahobbs7 commented Jul 27, 2026

Copy link
Copy Markdown
Collaborator Author

Tests currently fail due to the AFMReader updates being in PR state and hence the current pypi release being used instead. The dependencies may want to be updated to installing from the main branch with git (once the PR is merged) or a pypi release may need to be made for AFMReader before merging this branch.

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