Skip to content

Commit b523316

Browse files
authored
Merge pull request #198 from light-curve/markdown-pytest
Replace pytest-markdown with markdown-pytest
2 parents dfa9a3e + ace9bb7 commit b523316

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1111

1212
- Binary wheels for x86_64 Windows built with no Ceres nor GSL features https://github.com/light-curve/light-curve-python/issues/12 https://github.com/light-curve/light-curve-python/pull/185
1313
- CI: code coverage with `codecov` https://github.com/light-curve/light-curve-python/pull/197
14+
- Development: now project has extras for testing (`test`) and development (`dev`) https://github.com/light-curve/light-curve-python/pull/197
1415

1516
### Changed
1617

1718
- Bump `pyO3` 0.18.1 -> 0.18.2
1819
- Most of the parametric features have default values for their parameters now, which, due to `pyO3` limitations, are not presented in the signatures, but documented in the docstrings. It also makes Python and Rust implementations more consistent https://github.com/light-curve/light-curve-python/issues/194 https://github.com/light-curve/light-curve-python/pull/195
20+
- Development: switch from `pytest-markdown` to `markdown-pytest` which allowed us to use up-to-date pytest https://github.com/light-curve/light-curve-python/pull/198
1921

2022
### Deprecated
2123

light-curve/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ twine upload wheelhouse/*.whl
4242
Most of the classes implement various feature evaluators useful for light-curve based
4343
astrophysical source classification and characterisation.
4444

45+
<!-- name: test_feature_evaluators_basic -->
4546
```python
4647
import light_curve as lc
4748
import numpy as np
@@ -83,13 +84,15 @@ Note that if your inputs are not valid and are not validated by
8384
`sorted=None` and `check=True` (default values) then all kind of bad things could happen.
8485

8586
Print feature classes list
87+
<!-- name: test_feature_evaluators_list -->
8688
```python
8789
import light_curve as lc
8890

8991
print([x for x in dir(lc) if hasattr(getattr(lc, x), "names")])
9092
```
9193

9294
Read feature docs
95+
<!-- name: test_feature_evaluators_help -->
9396
```python
9497
import light_curve as lc
9598

@@ -105,6 +108,7 @@ However, the Python implementation provides some new feature extractors you can
105108

106109
You can manually use extractors from both implementations:
107110

111+
<!-- name: test_experimental_extractors -->
108112
```python
109113
import numpy as np
110114
from numpy.testing import assert_allclose
@@ -417,6 +421,7 @@ See benchmarks' descriptions in more details in ["Performant feature extraction
417421

418422
Class `DmDt` provides dm–dt mapper (based on [Mahabal et al. 2011](https://ui.adsabs.harvard.edu/abs/2011BASI...39..387M/abstract), [Soraisam et al. 2020](https://ui.adsabs.harvard.edu/abs/2020ApJ...892..112S/abstract)). It is a Python wrapper for [`light-curve-dmdt` Rust crate](https://crates.io/crates/light-curve-dmdt).
419423

424+
<!-- name: test_dmdt -->
420425
```python
421426
import numpy as np
422427
from light_curve import DmDt

light-curve/pyproject.toml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ test = [
2828
"pandas",
2929
"pytest",
3030
"pytest-benchmark",
31-
"pytest-markdown",
31+
"markdown-pytest",
3232
"pytest-subtests",
3333
]
3434
dev = [
@@ -100,7 +100,7 @@ minversion = "6.0"
100100
addopts = "-ra --import-mode=append --benchmark-min-time=0.1 --benchmark-max-time=5.0 --benchmark-sort=mean --benchmark-disable"
101101
testpaths = [
102102
"tests/",
103-
"README.md", # requires pytest-markdown
103+
"README.md", # requires markdown-pytest
104104
]
105105

106106
[tool.tox]
@@ -127,7 +127,7 @@ test-command = "pytest {package}/README.md {package}/light_curve/ {package}/test
127127
test-requires = [
128128
"pytest",
129129
"pytest-benchmark",
130-
"pytest-markdown",
130+
"markdown-pytest",
131131
"pytest-subtests",
132132
"numpy",
133133
"scipy",

0 commit comments

Comments
 (0)