Skip to content

Commit 06b8cc1

Browse files
authored
docs: update README for clarity and structure (#16)
1 parent 4718cdc commit 06b8cc1

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,22 @@
1010
pip install plotting_backends
1111
```
1212

13-
## Examples
13+
## Documentation
1414

15-
### `functools.singledispatch`
15+
The `plotting_backends` library provides a set of classes that can be used for
16+
dispatching plotting functions to different backends.
17+
18+
The common base class is `AbstractPlottingBackend` and the pre-defined backends
19+
are:
20+
21+
- `MatplotlibBackend`
22+
- `SeabornBackend`
23+
- `PlotlyBackend`
24+
- `BokehBackend`
25+
- `AltairBackend`
26+
- `GGPlotBackend`
27+
28+
### Using with `functools.singledispatch`
1629

1730
This shows how to use `plotting_backends` with `functools.singledispatch`.
1831

@@ -33,7 +46,7 @@ def matplotlib(
3346
) -> None: ...
3447
```
3548

36-
### `plum` (multiple dispatch)
49+
### Using with `plum` (multiple dispatch)
3750

3851
This example shows how to use `plotting_backends` in conjunction with `plum`, a
3952
multiple dispatch library.
@@ -55,6 +68,8 @@ def plotting_func(
5568
) -> None: ...
5669
```
5770

71+
---
72+
5873
## Development
5974

6075
[![Actions Status][actions-badge]][actions-link]

0 commit comments

Comments
 (0)