Skip to content

Commit 314de76

Browse files
committed
Minor edits on the README
1 parent b54871a commit 314de76

2 files changed

Lines changed: 18 additions & 21 deletions

File tree

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
[![minimal Python
66
version](https://img.shields.io/badge/Python%3E%3D-3.8-6666ff.svg)](https://www.anaconda.com/distribution/)
77
[![PyPI
8-
version](https://badge.fury.io/py/dabest)](https://badge.fury.io/py/dabest)
9-
[![Downloads](https://static.pepy.tech/badge/dabest.png)](https://pepy.tech/project/dabest)
8+
version](https://badge.fury.io/py/dabest.svg)](https://badge.fury.io/py/dabest)
9+
[![Downloads](https://img.shields.io/pepy/dt/dabest.png)](https://pepy.tech/project/dabest)
1010
[![Free-to-view
1111
citation](https://zenodo.org/badge/DOI/10.1038/s41592-019-0470-3.svg)](https://rdcu.be/bHhJ4)
1212
[![License](https://img.shields.io/badge/License-BSD%203--Clause--Clear-orange.svg)](https://spdx.org/licenses/BSD-3-Clause-Clear.html)
@@ -49,19 +49,15 @@ includes performance improvements.
4949

5050
<!-- TOC depthFrom:1 depthTo:2 withLinks:1 updateOnSave:1 orderedList:0 -->
5151

52-
- [DABEST-Python](#dabest-python)
53-
- [Recent Version Update](#recent-version-update)
54-
- [Contents](#contents)
55-
- [About](#about)
56-
- [Installation](#installation)
57-
- [Usage](#usage)
58-
- [How to cite](#how-to-cite)
59-
- [Bugs](#bugs)
60-
- [Contributing](#contributing)
61-
- [A wish list for new features](#a-wish-list-for-new-features)
62-
- [Acknowledgements](#acknowledgements)
63-
- [Testing](#testing)
64-
- [DABEST in other languages](#dabest-in-other-languages)
52+
- [About](#about)
53+
- [Installation](#installation)
54+
- [Usage](#usage)
55+
- [How to cite](#how-to-cite)
56+
- [Bugs](#bugs)
57+
- [Contributing](#contributing)
58+
- [Acknowledgements](#acknowledgements)
59+
- [Testing](#testing)
60+
- [DABEST in other languages](#dabest-in-other-languages)
6561

6662
<!-- /TOC -->
6763

@@ -165,8 +161,8 @@ PDF](https://rdcu.be/bHhJ4)
165161

166162
## Bugs
167163

168-
Please report any bugs on the [Github issue
169-
tracker](https://github.com/ACCLAB/DABEST-python/issues/new).
164+
Please report any bugs on the [issue
165+
page](https://github.com/ACCLAB/DABEST-python/issues/new).
170166

171167
## Contributing
172168

@@ -202,7 +198,7 @@ To test DABEST, you need to install
202198
- Run `pytest` in the root directory of the source distribution. This
203199
runs the test suite in the folder `dabest/tests/mpl_image_tests`.
204200
- Run `nbdev_test` in the root directory of the source distribution.
205-
This runs the value assertion tests in parent folder `dabest/tests`
201+
This runs the value assertion tests in the folder `dabest/tests`
206202

207203
The test suite ensures that the bootstrapping functions and the plotting
208204
functions perform as expected.

nbs/read_me.ipynb

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@
1515
"source": [
1616
"[![minimal Python version](https://img.shields.io/badge/Python%3E%3D-3.8-6666ff.svg)](https://www.anaconda.com/distribution/)\n",
1717
"[![PyPI version](https://badge.fury.io/py/dabest.svg)](https://badge.fury.io/py/dabest)\n",
18-
"[![Downloads](https://static.pepy.tech/badge/dabest)](https://pepy.tech/project/dabest)\n",
18+
"[![Downloads](https://img.shields.io/pepy/dt/dabest\n",
19+
")](https://pepy.tech/project/dabest)\n",
1920
"[![Free-to-view citation](https://zenodo.org/badge/DOI/10.1038/s41592-019-0470-3.svg)](https://rdcu.be/bHhJ4)\n",
2021
"[![License](https://img.shields.io/badge/License-BSD%203--Clause--Clear-orange.svg)](https://spdx.org/licenses/BSD-3-Clause-Clear.html)"
2122
]
@@ -157,7 +158,7 @@
157158
"\n",
158159
"## Bugs\n",
159160
"\n",
160-
"Please report any bugs on the [Github issue tracker](https://github.com/ACCLAB/DABEST-python/issues/new).\n",
161+
"Please report any bugs on the [issue page](https://github.com/ACCLAB/DABEST-python/issues/new).\n",
161162
"\n"
162163
]
163164
},
@@ -197,7 +198,7 @@
197198
"To test DABEST, you need to install [pytest](https://docs.pytest.org/en/latest) and [nbdev](https://nbdev.fast.ai/).\n",
198199
"\n",
199200
"- Run `pytest` in the root directory of the source distribution. This runs the test suite in the folder `dabest/tests/mpl_image_tests`. \n",
200-
"- Run `nbdev_test` in the root directory of the source distribution. This runs the value assertion tests in parent folder `dabest/tests`\n",
201+
"- Run `nbdev_test` in the root directory of the source distribution. This runs the value assertion tests in the folder `dabest/tests`\n",
201202
"\n",
202203
"The test suite ensures that the bootstrapping functions and the plotting functions perform as expected.\n",
203204
"\n",

0 commit comments

Comments
 (0)