Commit 13fd5cd
authored
[DOC] Fix confusing 'reverse complement' terminology in dataset and tutorial documentation (#538)
#### Reference Issues/PRs
Follow-up to PR #478 resolves #335
#### What does this implement/fix? Explain your changes.
This PR fixes the confusing "reverse complement" terminology that was
accidentally copy-pasted into the documentation across the repository.
As discussed in #478, the `augment_reverse` implementation does exactly
what was intended by the original paper (a simple string reversal). The
language in these files has been synced to reflect "reversed sequences"
to maintain technical accuracy and avoid biological confusion:
- `pyaptamer/datasets/dataclasses/_api.py` (APIDataset docstring and
`_prepare_data`)
- `examples/aptatrans_tutorial.ipynb` (Pipeline explanation cells)
- `pyaptamer/utils/_augment.py` (Return block docstring)
#### What should a reviewer concentrate their feedback on?
N/A - simple documentation/wording sync.
#### Did you add any tests for the change?
No (documentation only).
#### Any other comments?
None.
#### PR checklist
- [x] The PR title starts with either [ENH], [MNT], [DOC], or [BUG].
- [ ] Added/modified tests
- [x] Used pre-commit hooks when committing to ensure that code is
compliant with hooks. Install hooks with `pre-commit install`.1 parent 6cb2046 commit 13fd5cd
2 files changed
Lines changed: 9 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
113 | 113 | | |
114 | 114 | | |
115 | 115 | | |
116 | | - | |
| 116 | + | |
117 | 117 | | |
118 | 118 | | |
119 | 119 | | |
| |||
142 | 142 | | |
143 | 143 | | |
144 | 144 | | |
145 | | - | |
| 145 | + | |
146 | 146 | | |
147 | 147 | | |
148 | 148 | | |
| |||
182 | 182 | | |
183 | 183 | | |
184 | 184 | | |
185 | | - | |
| 185 | + | |
186 | 186 | | |
187 | 187 | | |
188 | 188 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
| 33 | + | |
34 | 34 | | |
35 | | - | |
36 | 35 | | |
37 | 36 | | |
38 | 37 | | |
| |||
67 | 66 | | |
68 | 67 | | |
69 | 68 | | |
70 | | - | |
71 | | - | |
| 69 | + | |
| 70 | + | |
72 | 71 | | |
73 | 72 | | |
74 | 73 | | |
| |||
78 | 77 | | |
79 | 78 | | |
80 | 79 | | |
81 | | - | |
82 | | - | |
83 | | - | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
84 | 83 | | |
85 | 84 | | |
86 | 85 | | |
| |||
0 commit comments