Skip to content

Commit 52edc71

Browse files
committed
chore: Replace scikit-package-logo-text.png and example-table.rst with placeholder files, fix docformatter for arbitrary.py
1 parent 381ef63 commit 52edc71

File tree

6 files changed

+14
-38
lines changed

6 files changed

+14
-38
lines changed

doc/source/img/.placeholder

Whitespace-only changes.
-183 KB
Binary file not shown.

doc/source/snippets/.placeholder

Whitespace-only changes.

doc/source/snippets/example-table.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,9 @@ skip = "*.cif,*.dat"
6767
recursive = true
6868
wrap-summaries = 72
6969
wrap-descriptions = 72
70+
exclude = [
71+
"src/diffpy/srmise/baselines/arbitrary.py"
72+
]
7073

7174
[tool.black]
7275
line-length = 115

src/diffpy/srmise/baselines/arbitrary.py

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,16 +26,17 @@
2626
class Arbitrary(BaselineFunction):
2727
"""Methods for evaluating a baseline from an arbitrary function.
2828
29-
Supports baseline calculations with arbitrary functions. These
30-
functions, if implemented, must have the following signatures and
31-
return values: valuef(pars, x) ==> numpy.array of length x if x is a
32-
sequence ==> number if x is a number jacobianf(pars,
33-
x, free) ==> list, each element a numpy.array of length x if
34-
x is a sequence or None if value of free for
35-
that parameter is False. ==> list, each
36-
element a number if x is a number or
37-
None if value of free for that parameter is
38-
False estimatef(x, y) ==> numpy.array of length npars
29+
Supports baseline calculations with arbitrary functions. These functions,
30+
if implemented, must have the following signatures and return values:
31+
valuef(pars, x) ==> numpy.array of length x if x is a sequence
32+
==> number if x is a number
33+
jacobianf(pars, x, free) ==> list, each element a numpy.array of length x if
34+
x is a sequence or None if value of free for
35+
that parameter is False.
36+
==> list, each element a number if x is a number
37+
or None if value of free for that parameter is
38+
False
39+
estimatef(x, y) ==> numpy.array of length npars
3940
"""
4041

4142
def __init__(self, npars, valuef, jacobianf=None, estimatef=None, Cache=None):

0 commit comments

Comments
 (0)