Skip to content

Doc/more details#76

Merged
acsenrafilho merged 4 commits intodevelopfrom
doc/more_details
Aug 21, 2025
Merged

Doc/more details#76
acsenrafilho merged 4 commits intodevelopfrom
doc/more_details

Conversation

@acsenrafilho
Copy link
Member

@acsenrafilho acsenrafilho commented Aug 21, 2025

Pull Request Template

Description

Type of Change

Please select the relevant option(s):

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📖 Documentation update (changes to documentation)
  • 🎨 Code style/formatting (non-functional changes)
  • ♻️ Code refactoring (no functional changes, no api changes)
  • ⚡ Performance improvements
  • 🧪 Test additions or improvements
  • 🔧 Build/CI configuration changes

Related Issues

Closes #38
Closes #43

Code Quality Checklist

Testing Requirements ✅

  • All existing tests pass
  • New functionality includes appropriate unit tests
  • Code follows the project's coding standards
  • Code passes linting checks (task lint-check)
  • Code includes appropriate inline documentation

Note: According to our contribution guidelines, please target the develop branch for most contributions to ensure proper testing before merging to main.

By submitting this pull request, I confirm:

  • I have read and followed the contribution guidelines
  • I have tested my changes thoroughly
  • I understand this is an open source project and my contributions may be used by others
  • I agree to the project's Code of Conduct

- Removed the `orientation_utils.py` file as it is no longer needed.
- Updated `asldata.md` to include a new section for ASLData class API and auxiliary methods.
- Enhanced `data.md` with detailed descriptions and added a new API section for the Data Module.
- Created a new `models.md` file to document the Models Module and its Signal Dynamic API.
- Expanded `reconstruction.md` to provide comprehensive details on the Reconstruction Module and its API.
- Introduced a new `registration.md` file to document the Registration Module and its APIs.
- Revised `reports.md` to reflect the new Reports Module structure and added API documentation.
- Enhanced `utils.md` with detailed descriptions of the Utils Module and its various APIs.
- Updated `getting_started.md` for clarity on accepted image formats.
- Corrected the title in `logging.md` for consistency.
- Deleted outdated scripts: `cbf_script.md`, `generate_sub_asl_image.md`, `multi_te_script.md`, and `t2_script.md`.
- Consolidated script documentation into `script_methods.md` for better organization.
- Updated `mkdocs.yml` to reflect the new documentation structure and removed references to deleted scripts.
@codecov
Copy link

codecov bot commented Aug 21, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.

Files with missing lines Coverage Δ
asltk/registration/asl_normalization.py 85.47% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@acsenrafilho acsenrafilho merged commit 7e9d523 into develop Aug 21, 2025
6 checks passed
@acsenrafilho acsenrafilho deleted the doc/more_details branch August 23, 2025 14:27
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