Skip to content

Commit 1b6b681

Browse files
authored
Merge pull request #207 from jhlegarreta/doc/improve-dmri-model-doc
DOC: Improve dMRI model documentation style
2 parents 1a2b962 + 91efd04 commit 1b6b681

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

src/nifreeze/model/dmri.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,12 @@ class BaseDWIModel(BaseModel):
5353
"_data_mask": "A mask for the voxels that will be fitted and predicted",
5454
"_S0": "The S0 (b=0 reference signal) that will be fed into DIPY models",
5555
"_model_class": "Defining a model class, DIPY models are instantiated automagically",
56-
"_modelargs": "Arguments acceptable by the underlying DIPY-like model.",
56+
"_modelargs": "Arguments acceptable by the underlying DIPY-like model",
5757
"_models": "List with one or more (if parallel execution) model instances",
5858
}
5959

6060
def __init__(self, dataset: DWI, max_b: float | int | None = None, **kwargs):
61-
r"""Initialization.
61+
"""Initialization.
6262
6363
Parameters
6464
----------
@@ -67,7 +67,7 @@ def __init__(self, dataset: DWI, max_b: float | int | None = None, **kwargs):
6767
6868
"""
6969

70-
# Duck typing, instead of explicitly test for DWI type
70+
# Duck typing, instead of explicitly testing for DWI type
7171
if not hasattr(dataset, "bzero"):
7272
raise TypeError("Dataset MUST be a DWI object.")
7373

0 commit comments

Comments
 (0)