Skip to content

Commit

Permalink
add mkdocstrings attempt 16
Browse files Browse the repository at this point in the history
  • Loading branch information
rpetit3 committed Aug 8, 2024
1 parent e1d652a commit 49be8b4
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
2 changes: 1 addition & 1 deletion camlhmp/engines/blast.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

def run_blast(engine: str, subject: str, query: str, min_pident: float, min_coverage: int) -> list:
"""
Query sequences against a input subject using BLASTN.
Query sequences against a input subject using BLAST+.
Args:
engine (str): The BLAST engine to use
Expand Down
10 changes: 10 additions & 0 deletions docs/api/engines.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,14 @@

## Blast

### `camlhmp.engines.blast.run_blast`

::: camlhmp.engines.blast.run_blast

### `camlhmp.engines.blast.run_blastn`

::: camlhmp.engines.blast.run_blastn

### `camlhmp.engines.blast.run_tblastn`

::: camlhmp.engines.blast.run_tblastn

0 comments on commit 49be8b4

Please sign in to comment.