Skip to content

Improve docs, small refactor of reconstruction measures#275

Merged
PicoCentauri merged 8 commits into
scikit-learn-contrib:mainfrom
sofiia-chorna:fre-docs-improvement
Oct 29, 2025
Merged

Improve docs, small refactor of reconstruction measures#275
PicoCentauri merged 8 commits into
scikit-learn-contrib:mainfrom
sofiia-chorna:fre-docs-improvement

Conversation

@sofiia-chorna

@sofiia-chorna sofiia-chorna commented Oct 28, 2025

Copy link
Copy Markdown
Contributor
  • Fixed parameter descriptions, added missing parameter description
  • Moved duplicated code to the separate function
  • Replaced assert with raised errors

Contributor (creator of PR) checklist

  • Tests updated (for new features and bugfixes)?
  • Documentation updated (for new features)?
  • Issue referenced (for PRs that solve an issue)?

For Reviewer

  • CHANGELOG updated if important change?

📚 Documentation preview 📚: https://scikit-matter--275.org.readthedocs.build/en/275/

@PicoCentauri PicoCentauri left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for the cleanup!

Can you maybe highlight the None as with backticks? I found a couple but probably I missed some.

Also, we could check removing the default from the docstring, if the rendering is good enough.

Comment thread src/skmatter/metrics/_reconstruction_measures.py Outdated
Comment thread src/skmatter/metrics/_reconstruction_measures.py Outdated
Comment thread src/skmatter/metrics/_reconstruction_measures.py Outdated
Comment thread src/skmatter/metrics/_reconstruction_measures.py Outdated
Comment thread src/skmatter/metrics/_reconstruction_measures.py Outdated
Comment thread src/skmatter/metrics/_reconstruction_measures.py Outdated
Comment thread src/skmatter/metrics/_reconstruction_measures.py Outdated
Comment thread src/skmatter/metrics/_reconstruction_measures.py
Comment thread src/skmatter/metrics/_reconstruction_measures.py Outdated
Comment thread src/skmatter/metrics/_reconstruction_measures.py
Comment thread src/skmatter/metrics/_reconstruction_measures.py

@PicoCentauri PicoCentauri left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wonderful. Just a small test and we can merge.

@PicoCentauri PicoCentauri left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! Thanks @sofiia-chorna for your first commit to scikit-matter 🚀

@PicoCentauri PicoCentauri merged commit 108ce37 into scikit-learn-contrib:main Oct 29, 2025
10 checks passed
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.

2 participants