Commit 66cd7fd
authored
[DOC] Fix PSeAAC docstring errors and malformed error messages (#360)
#### Reference Issues/PRs
Fixes previously unreported issues in the `pseaac` module.
#### What does this implement/fix? Explain your changes.
Four fixes:
1. `PSeAAC.transform()` docstring listed `lambda_val` and `weight` as
parameters but the method only takes `protein_sequence`. Also had wrong
default `0.15` vs actual `0.05`. Removed phantom params.
2. `AptaNetPSeAAC` docstring example imported `PSeAAC` instead of
`AptaNetPSeAAC`. Fixed.
3. Missing space in f-string: `"divisible by" f"group_props"` →
`"divisible bygroup_props"`. Added space.
4. Missing space: `"custom_groups`,not both."` → `", not both."`.
#### What should a reviewer concentrate their feedback on?
- Whether the `transform()` docstring is accurate after removing the
phantom params
#### Did you add any tests for the change?
Yes. Added `test_pseaac_group_props_and_custom_groups_conflict` and
`test_pseaac_indivisible_group_props` to
`pyaptamer/pseaac/tests/test_pseaac.py`.
#### Any other comments?
- `pytest pyaptamer/pseaac/tests/test_pseaac.py` — 13 passed
- `pre-commit run --all-files` — all passed
#### PR checklist
- [x] The PR title starts with either [ENH], [MNT], [DOC], or [BUG].
- [x] Added/modified tests
- [x] Used pre-commit hooks when committing to ensure that code is
compliant with hooks.
Co-authored-by: kunal14901 <kunal14901@users.noreply.github.com>1 parent c01f3fb commit 66cd7fd
3 files changed
Lines changed: 16 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
92 | | - | |
93 | | - | |
| 92 | + | |
| 93 | + | |
94 | 94 | | |
95 | 95 | | |
96 | 96 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
127 | 127 | | |
128 | 128 | | |
129 | 129 | | |
130 | | - | |
| 130 | + | |
131 | 131 | | |
132 | 132 | | |
133 | 133 | | |
| |||
148 | 148 | | |
149 | 149 | | |
150 | 150 | | |
151 | | - | |
| 151 | + | |
152 | 152 | | |
153 | 153 | | |
154 | 154 | | |
| |||
219 | 219 | | |
220 | 220 | | |
221 | 221 | | |
222 | | - | |
223 | | - | |
224 | | - | |
225 | | - | |
226 | | - | |
227 | | - | |
228 | 222 | | |
229 | 223 | | |
230 | 224 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
125 | 125 | | |
126 | 126 | | |
127 | 127 | | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
0 commit comments