Skip to content

Commit

Permalink
docs: add package description (#158)
Browse files Browse the repository at this point in the history
* ci: upgrade pinned requirements
* ci: convert .prettierrc to YAML
* fix: update Prettier badge

Co-authored-by: GitHub <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
3 people authored Sep 21, 2021
1 parent cb8288f commit 408e684
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 14 deletions.
4 changes: 2 additions & 2 deletions .constraints/py3.6.txt
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ pytest-cov==2.12.1
pytest-forked==1.3.0
pytest-notebook==0.6.1
pytest-profiling==1.7.0
pytest-xdist==2.3.0
pytest-xdist==2.4.0
python-constraint==1.4.0
python-dateutil==2.8.2
pytz==2021.1
Expand Down Expand Up @@ -182,7 +182,7 @@ toml==0.10.2
tomli==1.2.1
tornado==6.1
tox==3.24.4
tqdm==4.62.2
tqdm==4.62.3
traitlets==4.3.3
typed-ast==1.4.3
types-docutils==0.17.0
Expand Down
4 changes: 2 additions & 2 deletions .constraints/py3.7.txt
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ pytest-cov==2.12.1
pytest-forked==1.3.0
pytest-notebook==0.6.1
pytest-profiling==1.7.0
pytest-xdist==2.3.0
pytest-xdist==2.4.0
python-constraint==1.4.0
python-dateutil==2.8.2
pytz==2021.1
Expand Down Expand Up @@ -181,7 +181,7 @@ toml==0.10.2
tomli==1.2.1
tornado==6.1
tox==3.24.4
tqdm==4.62.2
tqdm==4.62.3
traitlets==5.1.0
typed-ast==1.4.3
types-docutils==0.17.0
Expand Down
4 changes: 2 additions & 2 deletions .constraints/py3.8.txt
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ pytest-cov==2.12.1
pytest-forked==1.3.0
pytest-notebook==0.6.1
pytest-profiling==1.7.0
pytest-xdist==2.3.0
pytest-xdist==2.4.0
python-constraint==1.4.0
python-dateutil==2.8.2
pytz==2021.1
Expand Down Expand Up @@ -180,7 +180,7 @@ toml==0.10.2
tomli==1.2.1
tornado==6.1
tox==3.24.4
tqdm==4.62.2
tqdm==4.62.3
traitlets==5.1.0
types-docutils==0.17.0
typing-extensions==3.10.0.2
Expand Down
4 changes: 2 additions & 2 deletions .constraints/py3.9.txt
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ pytest-cov==2.12.1
pytest-forked==1.3.0
pytest-notebook==0.6.1
pytest-profiling==1.7.0
pytest-xdist==2.3.0
pytest-xdist==2.4.0
python-constraint==1.4.0
python-dateutil==2.8.2
pytz==2021.1
Expand Down Expand Up @@ -180,7 +180,7 @@ toml==0.10.2
tomli==1.2.1
tornado==6.1
tox==3.24.4
tqdm==4.62.2
tqdm==4.62.3
traitlets==5.1.0
types-docutils==0.17.0
typing-extensions==3.10.0.2
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ repos:
- id: trailing-whitespace

- repo: https://github.com/ComPWA/repo-maintenance
rev: 0.0.28
rev: 0.0.35
hooks:
- id: check-dev-files
args:
Expand Down
6 changes: 2 additions & 4 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
{
"proseWrap": "always",
"printWidth": 79
}
printWidth: 79
proseWrap: always
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/70fc5fb0f3954a9d82d142efeff4df31)](https://www.codacy.com/gh/ComPWA/ampform)
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/ComPWA/ampform/main.svg)](https://results.pre-commit.ci/latest/github/ComPWA/ampform/main)
[![Spelling checked](https://img.shields.io/badge/cspell-checked-brightgreen.svg)](https://github.com/streetsidesoftware/cspell/tree/master/packages/cspell)
[![Prettier](https://camo.githubusercontent.com/687a8ae8d15f9409617d2cc5a30292a884f6813a/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f636f64655f7374796c652d70726574746965722d6666363962342e7376673f7374796c653d666c61742d737175617265)](https://prettier.io/)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort)

Expand Down
1 change: 1 addition & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[metadata]
name = ampform
description = Automatically generate symbolic amplitude models for Partial Wave Analysis
author = Common Partial Wave Analysis
author_email = [email protected]
maintainer_email = [email protected]
Expand Down

0 comments on commit 408e684

Please sign in to comment.