Skip to content

Commit

Permalink
chore: tweak project TOML + README
Browse files Browse the repository at this point in the history
  • Loading branch information
sr-murthy committed Feb 20, 2024
1 parent eb42fab commit 7ec796d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![License: MPL
2.0](https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg)](https://opensource.org/licenses/MPL-2.0)
<a href="https://trackgit.com">
<img src="https://us-central1-trackgit-analytics.cloudfunctions.net/token/ping/lstbybzreip1xu8hdsls" alt="trackgit-views" />
<img src="https://us-central1-trackgit-analytics.cloudfunctions.net/token/ping/lsudelfvcxb7f1xm6i4l" alt="trackgit-views" />
</a>

</div>
Expand Down Expand Up @@ -364,11 +364,12 @@ For more information on PDM lockfiles and installing requirements see the [PDM d
The [`Makefile`](Makefile) defines three main targets: `lint` for Ruff linting, `doctests` for running [doctests](https://docs.python.org/3/library/doctest.html) and `unittests` for running unittests and measuring coverage, using `pytest` and the `pytest-cov` plugin:

```bash
make lint
make doctests
make unittests
```

The doctests serve as acceptance tests, and should be run first, before the unit tests.
Linting warnings should be addressed first. The doctests serve as acceptance tests, and should be run first, before the unit tests.

### Continous Integration and Deployment (CI/CD)

Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# https://packaging.python.org/en/latest/tutorials/packaging-projects/
#
name = "continuedfractions"
description = "Object-oriented continued fractions"
description = "Continued fractions with Python"

authors = [
{name = "Sandeep R. Murthy", email = "s.murthy@tutanota.com"},
Expand Down Expand Up @@ -92,7 +92,7 @@ excludes = [
]
source-includes = [
"LICENSE",
"README.rst",
"README.md",
]
editable-backend = "path"

Expand Down

0 comments on commit 7ec796d

Please sign in to comment.