Improve doc strings#142
Open
mikemhenry wants to merge 40 commits intomainfrom
Open
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #142 +/- ##
=======================================
Coverage 98.16% 98.16%
=======================================
Files 13 13
Lines 654 654
=======================================
Hits 642 642
Misses 12 12 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Contributor
Author
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
|
No API break detected ✅ |
This was referenced Mar 18, 2026
atravitz
reviewed
Mar 25, 2026
| ---------- | ||
| mol : SmallMoleculeComponent | ||
| molecule to be aligned to molA (will be moved) | ||
| Molecule to be aligned to `ref_mol` (will be moved). |
Contributor
There was a problem hiding this comment.
Suggested change
| Molecule to be aligned to `ref_mol` (will be moved). | |
| Molecule to be aligned to ``ref_mol`` (will be moved). |
Here and everywhere else, we should use double quotes so it renders as code and not italics in the docs:
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In this PR I used Qwen2.5-Coder-32B-Instruct with Aider v0.86.2. For each file I added the file to the context, and then used this prompt "Update docstrings to NumPy style in this file only. Do not modify other files."
Checklist
newsentry, or the changes are not user-facing.pre-commit.ci autofix.Developers certificate of origin