Skip to content

Unify doc comments of previous pull request. #102

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sebschmi merged 2 commits into from
Nov 3, 2025
Merged

Unify doc comments of previous pull request. #102

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9eeff8c
Unify doc comments of previous pull request.
sebschmi Nov 3, 2025
9075a49
Hopefully fix python build.
sebschmi Nov 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 14 additions & 16 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 6 additions & 3 deletions lib_tsalign/src/a_star_aligner/alignment_result/alignment/template_switch_specifics.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,8 @@ impl Alignment<AlignmentType> {
/// Moves the start of a template switch one character pair to the right if possible, moving the character pair out of the template switch.
///
/// Only works if the first alignment inside the template switch is a match or substitution.
/// In this case it returns true, and otherwise false.
///
/// In case of success, it returns true, and otherwise false.
///
/// Assumes that the template switch is not preceded by a flank.
///
Expand Down Expand Up @@ -295,7 +296,8 @@ impl Alignment<AlignmentType> {
/// Moves the end of a template switch one character pair to the right if possible, moving the character pair into the template switch.
///
/// Only works if the alignment preceding the template switch is a match or substitution, and not a flank.
/// In this case it returns true, and otherwise false.
///
/// In case of success, it returns true, and otherwise false.
///
/// Compact index identifies the start of the template switch in terms of the compact representation of the alignment.
/// See [`Self::iter_compact`].
Expand Down Expand Up @@ -465,7 +467,8 @@ impl Alignment<AlignmentType> {
/// Moves the end of a template switch one character pair to the left if possible, moving the character pair out of the template switch.
///
/// Only works if the last alignment inside the template switch is a match or substitution.
/// In this case it returns true, and otherwise false.
///
/// In case of success, it returns true, and otherwise false.
///
/// Assumes that the template switch is not succeeded by a flank.
///
Expand Down
15 changes: 10 additions & 5 deletions python_bindings/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
name = "py_lib_tsalign"
description = "Python Bindings for `lib_tsalign`"
license.workspace = true
authors = ["Sebastian Schmidt <sebastian.schmidt@helsinki.fi>", "Jasper Krauter <jasper.krauter@helsinki.fi>"]
authors = [
"Sebastian Schmidt <sebastian.schmidt@helsinki.fi>",
"Jasper Krauter <jasper.krauter@helsinki.fi>",
]
version = "0.3.1"
edition.workspace = true
rust-version.workspace = true
Expand All @@ -14,9 +17,11 @@ doc = false
crate-type = ["cdylib"]

[dependencies]
pyo3 = "0.24.0"
lib_tsalign = { version = "0.18.1", path = "../lib_tsalign", features = ["serde"] }
pyo3 = "0.26.0"
lib_tsalign = { version = "0.18.1", path = "../lib_tsalign", features = [
"serde",
] }
lib_tsshow = { version = "0.18.1", path = "../lib_tsshow" }
serde.workspace = true
pythonize = "0.24.0"
pyo3-log = "0.12.3"
pythonize = "0.26.0"
pyo3-log = "0.13.2"
Loading