Skip to content

Commit

Permalink
fix github action badge in README.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
PicoCentauri committed Jun 26, 2024
1 parent a74ebaa commit f9c43ac
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 12 deletions.
4 changes: 2 additions & 2 deletions .codecov.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ coverage:
status:
project:
default:
target: 90%
target: 95%
patch:
default:
target: 90%
target: 95%

comment: false
11 changes: 6 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ scikit-matter
=============
|tests| |codecov| |pypi| |conda| |docs| |doi|

A collection of scikit-learn compatible utilities that implement methods born out of the
materials science and chemistry communities.
A collection of ``scikit-learn`` compatible utilities that implement methods born out of
the materials science and chemistry communities.

For details, tutorials, and examples, please have a look at our `documentation`_.

Expand Down Expand Up @@ -90,10 +90,9 @@ Thanks goes to all people that make scikit-matter possible:
.. image:: https://contrib.rocks/image?repo=scikit-learn-contrib/scikit-matter
:target: https://github.com/scikit-learn-contrib/scikit-matter/graphs/contributors

.. |tests| image:: https://github.com/scikit-learn-contrib/scikit-matter/workflows/Test/badge.svg
.. |tests| image:: https://github.com/scikit-learn-contrib/scikit-matter/workflows/Tests/badge.svg
:alt: Github Actions Tests Job Status
:target: (https://github.com/scikit-learn-contrib/scikit-matter/\
actions?query=workflow%3ATests)
:target: action_

.. |codecov| image:: https://codecov.io/gh/scikit-learn-contrib/scikit-matter/branch/main/graph/badge.svg?token=UZJPJG34SM
:alt: Code coverage
Expand All @@ -114,3 +113,5 @@ Thanks goes to all people that make scikit-matter possible:
.. |doi| image:: https://img.shields.io/badge/DOI-10.12688-blue
:alt: ORE Paper
:target: https://doi.org/10.12688/openreseurope.15789.2

.. _`action`: https://github.com/scikit-learn-contrib/scikit-matter/actions?query=branch%3Amain
4 changes: 2 additions & 2 deletions examples/README.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Examples
========

For a thorough tutorial of the methods introduced in `scikit-matter`, we
For a thorough tutorial of the methods introduced in ``scikit-matter``, we
suggest you check out the pedagogic notebooks in our companion project
`kernel-tutorials <https://github.com/lab-cosmo/kernel-tutorials/>`_.

For running the examples locally install `scikit-matter` with the ``examples``
For running the examples locally install ``scikit-matter`` with the ``examples``
optional dependencies.

.. code-block:: bash
Expand Down
4 changes: 2 additions & 2 deletions src/skmatter/datasets/descr/who_dataset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
WHO dataset
###########

`who_dataset.csv` is a compilation of multiple publically-available datasets
``who_dataset.csv`` is a compilation of multiple publically-available datasets
through data.worldbank.org. Specifically, the following versioned datasets are used:

- NY.GDP.PCAP.CD (v2_4770383) [1]_
Expand All @@ -17,7 +17,7 @@ through data.worldbank.org. Specifically, the following versioned datasets are u
- SP.DYN.LE00.IN (v2_4770556) [9]_
- SP.POP.TOTL (v2_4770385) [10]_

where the corresponding file names are `API_{dataset}_DS2_excel_en_{version}.xls`.
where the corresponding file names are ``API_{dataset}_DS2_excel_en_{version}.xls``.

This dataset, intended only for demonstration, contains 2020 country-year pairings and
the corresponding values above.
Expand Down
2 changes: 1 addition & 1 deletion tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ commands =
black --check --diff {[tox]lint_folders}
blackdoc --check --diff {[tox]lint_folders}
isort --check-only --diff {[tox]lint_folders}
sphinx-lint --enable line-too-long --max-line-length 88 \
sphinx-lint --enable all --max-line-length 88 \
-i "{toxinidir}/docs/src/examples" \
{[tox]lint_folders} "{toxinidir}/README.rst"

Expand Down

0 comments on commit f9c43ac

Please sign in to comment.