Update key and URLs in README.md #48
Conversation
README.rst
Outdated
| @@ -88,7 +88,7 @@ To use the stylesheet, near the beginning your python script type :: | |||
| for example :: | |||
|
|
|||
| from bg_mpl_stylesheets.styles import all_styles | |||
| plt.style.use(all_styles["bg-style"]) | |||
| plt.style.use(all_styles["bg_style"]) | |||
There was a problem hiding this comment.
I searched "bg-style" globally and this was the only place found.
| @@ -8,8 +8,8 @@ bg-mpl-stylesheets | |||
| .. |Black| image:: https://img.shields.io/badge/code_style-black-black | |||
| :target: https://github.com/psf/black | |||
|
|
|||
| .. |Codecov| image:: https://codecov.io/gh/bg-mpl-stylesheets/bg-mpl-stylesheets/branch/main/graph/badge.svg | |||
| :target: https://codecov.io/gh/bg-mpl-stylesheets/bg-mpl-stylesheets | |||
| .. |Codecov| image:: https://codecov.io/gh/Billingegroup/bg-mpl-stylesheets/branch/main/graph/badge.svg | |||
There was a problem hiding this comment.
Many URLs didn't work as the organization was moved from bg-mpl-stylesheets to Billingegroup.
There was a problem hiding this comment.
thanks for catching and fixing that.
|
@sbillinge Please review! News added. |
| @@ -102,7 +102,7 @@ def update_style_with_latex(style): | |||
| return style | |||
|
|
|||
|
|
|||
| all_styles = {"bg_style": bg_style} | |||
| all_styles = {"bg-style": bg_style} | |||
There was a problem hiding this comment.
This only place that remains as bg_style is the variable name since we are not able to use -.
@sbillinge Please review. |
| @@ -102,7 +102,7 @@ def update_style_with_latex(style): | |||
| return style | |||
|
|
|||
|
|
|||
| all_styles = {"bg_style": bg_style} | |||
| all_styles = {"bg-style": bg_style} | |||
Problem
The
README.mdwas not updated.plt.style.use(all_styles["bg-style"])results in the following key error:Solution
Use
(all_styles["bg_style"])instead.Proof:
Reference
https://github.com/Billingegroup/bg-mpl-stylesheets/blob/4d2ffc384b7becf7a1929fd9f3f592c85a916408/src/bg_mpl_stylesheets/tests/test_bg_mpl_stylesheet.py#L6C2-L9C12