Skip to content

Commit bc76938

Browse files
committed
minor typo and style fixes in README.rst
1 parent 7642e99 commit bc76938

File tree

2 files changed

+8
-18
lines changed

2 files changed

+8
-18
lines changed

README.rst

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
scikit-matter
22
=============
3-
43
|tests| |codecov| |pypi| |conda| |docs| |doi|
54

65
A collection of scikit-learn compatible utilities that implement methods born out of the
@@ -14,41 +13,35 @@ For details, tutorials, and examples, please have a look at our `documentation`_
1413
1514
Installation
1615
------------
17-
1816
You can install *scikit-matter* either via pip using
1917

2018
.. code-block:: bash
2119
2220
pip install skmatter
2321
24-
2522
or conda
2623

2724
.. code-block:: bash
2825
2926
conda install -c conda-forge skmatter
3027
31-
3228
You can then ``import skmatter`` and use scikit-matter in your projects!
3329

3430
.. marker-ci-tests
3531
3632
Tests
3733
-----
34+
We are testing our code for Python 3.8 and 3.12 on `Windows Server 2019`_, `macOS 11`_
35+
and `Ubuntu LTS 22.04`_.
3836

39-
We are testing our code for Python 3.8 and 3.11 on `Windows Server 2019
40-
<https://github.com/actions/runner-images/blob/main/images/win/Windows2019-Readme.md>`_,
41-
`macOS 11
42-
<https://github.com/actions/runner-images/blob/main/images/macos/macos-11-Readme.md>`_
43-
and `Ubuntu LTS 22.04
44-
<https://github.com/actions/runner-images/
45-
blob/main/images/linux/Ubuntu2204-Readme.md>`_.
37+
.. _`Windows Server 2019`: https://github.com/actions/runner-images/blob/main/images/win/Windows2019-Readme.md
38+
.. _`macOS 11`: https://github.com/actions/runner-images/blob/main/images/macos/macos-11-Readme.md
39+
.. _`Ubuntu LTS 22.04`: https://github.com/actions/runner-images/blob/main/images/linux/Ubuntu2204-Readme.md
4640

4741
.. marker-issues
4842
4943
Having problems or ideas?
5044
-------------------------
51-
5245
Having a problem with scikit-matter? Please let us know by `submitting an issue
5346
<https://github.com/scikit-learn-contrib/scikit-matter/issues>`_.
5447

@@ -59,7 +52,6 @@ Submit new features or bug fixes through a `pull request
5952
6053
Call for Contributions
6154
----------------------
62-
6355
We always welcome new contributors. If you want to help us take a look at our
6456
`contribution guidelines`_ and afterwards you may start with an open issue marked as
6557
`good first issue`_.
@@ -84,8 +76,7 @@ Writing code is not the only way to contribute to the project. You can also:
8476
8577
Citing scikit-matter
8678
--------------------
87-
88-
If you use scikit-matter for your work, please cite:
79+
If you use *scikit-matter* for your work, please cite:
8980

9081
Goscinski A, Principe VP, Fraux G et al. scikit-matter :
9182
A Suite of Generalisable Machine Learning Methods Born out of Chemistry
@@ -94,7 +85,6 @@ and Materials Science. Open Res Europe 2023, 3:81.
9485

9586
Contributors
9687
------------
97-
9888
Thanks goes to all people that make scikit-matter possible:
9989

10090
.. image:: https://contrib.rocks/image?repo=scikit-learn-contrib/scikit-matter

tox.ini

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ commands =
6666
blackdoc --check --diff {[tox]lint_folders}
6767
isort --check-only --diff {[tox]lint_folders}
6868
sphinx-lint --enable line-too-long --max-line-length 88 \
69-
-i "{toxinidir}/docs/src/examples" \
70-
{[tox]lint_folders} "{toxinidir}/README.rst"
69+
-i "{toxinidir}/docs/src/examples" \
70+
{[tox]lint_folders} "{toxinidir}/README.rst"
7171

7272
[testenv:{format,format-unsafe}]
7373
description =

0 commit comments

Comments
 (0)