Skip to content

Commit 33646d7

Browse files
committed
fix: clarify package description and improve style comparison formatting in index.md
1 parent 7774be2 commit 33646d7

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

docs/index.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What is `physics-plot`?
44

5-
`physics-plot` is a lightweight python package shipping a [Matplotlib style sheet](https://matplotlib.org/stable/gallery/style_sheets/style_sheets_reference.html) called [`pp_base.mplstyle`](https://github.com/c0rychu/physics-plot/blob/main/src/physics_plot/pp_base.mplstyle) and a few helper functions to create publication-quality plots with minimal effort.
5+
`physics-plot` is essentially a zero dependency python package shipping a Matplotlib style sheet [^mplstyle] [`pp_base.mplstyle`](https://github.com/c0rychu/physics-plot/blob/main/src/physics_plot/pp_base.mplstyle) to create publication-quality plots with minimal effort. In addition, a few optional helper classes are provided.
66

77
An example Bode plot created with `physics-plot` looks like this:
88
![Bode plot](fig/[email protected])
@@ -12,7 +12,7 @@ An example Bode plot created with `physics-plot` looks like this:
1212

1313
Here's a side-by-side comparison of plotting with the `physics-plot` style and the Matplotlib default style:
1414

15-
| *`physics-plot` style.* | *Matplotlib default style.* |
15+
| `physics-plot` style | Matplotlib default style |
1616
|:--:|:--:|
1717
| <img src="fig/[email protected]" width="400"> | <img src="fig/[email protected]" width="400"> |
1818

@@ -45,4 +45,7 @@ with plt.style.context("physics_plot.pp_base"):
4545
# ======================= #
4646
```
4747

48-
Yes! That's it! You are now ready to create beautiful, publication-quality plots with minimal effort using the `physics-plot` style. Enjoy plotting!
48+
Yes! That's it! You are now ready to create beautiful, publication-quality plots with minimal effort using the `physics-plot` style. Enjoy plotting!
49+
50+
51+
[^mplstyle]: Matplotlib style sheets (`.mplstyle` files) are configuration files that define the default appearance of plots created with Matplotlib. They allow users to customize various aspects of plot aesthetics, such as colors, fonts, line styles, and more, by specifying these settings in a structured format. See [Matplotlib Style Sheets Reference](https://matplotlib.org/stable/gallery/style_sheets/style_sheets_reference.html) for more details.

0 commit comments

Comments
 (0)