Skip to content

Commit 09182b4

Browse files
committed
Few more minor docu cleanups
1 parent bbb6f94 commit 09182b4

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

src/stacie/model.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -526,7 +526,7 @@ class LorentzModel(PadeModel):
526526
"""A model for the spectrum with a Lorentzian peak at zero frequency plus some white noise.
527527
528528
This is a special case of the PadeModel with
529-
`numer_degrees` = [0, 2] and `denom_degrees` = [2].
529+
``numer_degrees = [0, 2]`` and ``denom_degrees = [2]``.
530530
Furthermore, it will only accept parameters that correspond
531531
to a well-defined exponential correlation time.
532532
@@ -549,7 +549,7 @@ class LorentzModel(PadeModel):
549549
Because the penalty is expressed as a ratio of relative errors, it is dimensionless
550550
and insensitive to the overall uncertainty of the spectrum.
551551
552-
The hyperparameters `ratio_weight` and `ratio_threshold` may be tuned
552+
The hyperparameters ``ratio_weight`` and ``ratio_threshold`` may be tuned
553553
to adjust the sensitivity of the heuristic, but it is recommended to keep
554554
their default values.
555555
"""

src/stacie/utils.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ def cub(self) -> float:
121121

122122

123123
def label_unit(label: str, unit_str: str | None) -> str:
124-
"""Format a label with the unit string as `label [unit]`.
124+
"""Format a label with the unit string as ``label [unit]``.
125125
126126
When the unit is ``""`` or ``None``, the unit is omitted.
127127

0 commit comments

Comments
 (0)