Skip to content

Improve/update doc strings for upcoming release-3.2.0#215

Merged
ChaitanyaChawak merged 6 commits into
developfrom
214-documentation-release-320-documentation
Apr 28, 2026
Merged

Improve/update doc strings for upcoming release-3.2.0#215
ChaitanyaChawak merged 6 commits into
developfrom
214-documentation-release-320-documentation

Conversation

@jeipollack

@jeipollack jeipollack commented Apr 27, 2026

Copy link
Copy Markdown
Contributor

Summary

This PR features updates to the API documentation in preparation for release-3.2.0.

What’s changed

  • Doc strings in the data package were updated or improved for clarity
  • SupportsMetadata protocol was removed following live-testing; metadata is optional and thus not required
  • Configurations.md updates describing new data configuration features - complete, split, shallow with train fraction ratios & seed, and canonical parameter settings

How to test / verify

  • run make html
  • open build/html/index.html
  • Review the documentation locally in the web browser

Scope

Indicate the type of PR:

  • Feature
  • Bug fix
  • Hotfix
  • Documentation / process change
  • Internal / refactor
  • Release

Optionally, note if this PR is part of a larger milestone or set of related PRs.

Changelog

Did this PR introduce user-visible changes?
If yes, a Scriv changelog fragment must be added and committed.

  • Changelog fragment added (if applicable)

Reviewer Checklist

Reviewers should confirm the following before approving and merging:

  • The PR targets the correct base branch (develop, or main for release PRs)
  • The PR is assigned to the developer
  • Appropriate labels are applied
  • The PR is included in relevant projects and/or milestones
  • Description clearly explains what has changed
  • Issue references included, if applicable
  • Code and documentation adhere to current standards (ruff)
  • Documentation updates included, if relevant
  • CI tests are passing
  • All reviewer comments have been addressed

Next Steps / Notes (if applicable)

Prepare release PR and collect changelog fragments

@jeipollack jeipollack self-assigned this Apr 27, 2026
@jeipollack jeipollack added the documentation Improvements or additions to documentation label Apr 27, 2026
Jennifer Pollack added 4 commits April 28, 2026 11:35
- Remove deprecated load_on_init parameter
- Improve doc strings for clarity
- Update Data Configuration section detailing different configuration modes
- Update Training Configuration section with new monitor parameter
- Replace n_bins_lda with n_bins_lambda
@jeipollack jeipollack force-pushed the 214-documentation-release-320-documentation branch from 4c43759 to e77c673 Compare April 28, 2026 09:36
Comment thread docs/source/configuration.md
@ChaitanyaChawak ChaitanyaChawak merged commit 37031d3 into develop Apr 28, 2026
2 checks passed
@ChaitanyaChawak ChaitanyaChawak deleted the 214-documentation-release-320-documentation branch April 28, 2026 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Development

Successfully merging this pull request may close these issues.

2 participants