Skip to content

Commit

Permalink
Fix docs links in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
daemontus committed Mar 23, 2024
1 parent 488ea16 commit c3f1664
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[![PyPI](https://img.shields.io/pypi/v/balm?style=flat-square)](https://pypi.org/project/balm/)
[![Api Docs](https://img.shields.io/badge/docs-api-yellowgreen?style=flat-square)](https://todo.docs.url)
[![Continuous integration](https://img.shields.io/github/actions/workflow/status/jcrozum/balm/test.yml?branch=master&style=flat-square)](https://github.com/jcrozum/balm/actions?query=workflow%3Atest)
[![Api Docs](https://img.shields.io/badge/docs-api-yellowgreen?style=flat-square)](https://jcrozum.github.io/balm/)
[![Continuous integration](https://img.shields.io/github/actions/workflow/status/jcrozum/balm/test.yml?branch=main&style=flat-square)](https://github.com/jcrozum/balm/actions?query=workflow%3Atest)
[![Coverage](https://img.shields.io/codecov/c/github/jcrozum/balm?style=flat-square)](https://codecov.io/gh/jcrozum/balm)
[![GitHub issues](https://img.shields.io/github/issues/jcrozum/balm?style=flat-square)](https://github.com/jcrozum/balm/issues)
[![License](https://img.shields.io/pypi/l/balm?style=flat-square)](https://github.com/jcrozum/balm/blob/main/LICENSE)
Expand Down Expand Up @@ -34,7 +34,7 @@ pip install git+https://github.com/jcrozum/balm.git@main

### Using BALM

To learn more about how BALM functions, you can explore the example notebooks listed below. Alternatively, BALM's API documentation is also available [online](https://todo.docs.url).
To learn more about how BALM functions, you can explore the example notebooks listed below. Alternatively, BALM's API documentation is also available [online](https://jcrozum.github.io/balm/).

**TODO: Usage examples coming soon.**

1 comment on commit c3f1664

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
balm
   control.py1141488%107, 119, 125, 129, 134, 143–159, 477, 480, 493
   interaction_graph_utils.py30487%11–13, 151–152
   motif_avoidant.py148299%26, 181
   petri_net_translation.py1491193%22–26, 79, 136, 305–306, 330–331, 340, 449
   space_utils.py129497%26–28, 406, 454
   succession_diagram.py2571694%6, 184–189, 197, 257–258, 268, 274, 390, 580, 772, 810, 847
   symbolic_utils.py26388%10–12, 102
   trappist_core.py1833084%14–18, 55, 57, 92, 168, 215, 217, 219, 247–250, 254–256, 276–282, 340, 342, 372, 420, 422, 453, 506
balm/_sd_algorithms
   compute_attractor_seeds.py30197%8
   expand_attractor_seeds.py51590%6, 42, 97–102
   expand_bfs.py28196%6
   expand_dfs.py30197%6
   expand_minimal_spaces.py37295%6, 31
   expand_source_SCCs.py164696%19–21, 91, 101, 143, 287
   expand_to_target.py31390%6, 38, 43
TOTAL146810393% 

Tests Skipped Failures Errors Time
361 0 💤 0 ❌ 0 🔥 34.304s ⏱️

Please sign in to comment.