Skip to content

Commit

Permalink
DOC: Do not use unfinished double backticks
Browse files Browse the repository at this point in the history
Do not use unfinished double backticks: Sphinx interprets them as
unfinished inline literals. Change them to quotes in third-party
licence documentation.

Fixes:
```
/dipy/segment/mask.py:docstring of dipy.segment.mask.median_otsu:65:
 WARNING: Inline literal start-string without end-string.
```

and
```
/dipy/workflows/docstring_parser.py:docstring of dipy.workflows.docstring_parser:17:
 WARNING: Inline literal start-string without end-string.
```

raised for example at:
https://github.com/dipy/dipy/actions/runs/10472634043/job/29002561651#step:5:1146
and
https://github.com/dipy/dipy/actions/runs/10472634043/job/29002561651#step:5:1145
  • Loading branch information
jhlegarreta committed Aug 20, 2024
1 parent 754b5e7 commit ffdbde9
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion dipy/segment/mask.py
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ def median_otsu(
used to endorse or promote products derived from this software without
specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
Expand Down
2 changes: 1 addition & 1 deletion dipy/workflows/docstring_parser.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
the documentation and/or other materials provided with the
distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
Expand Down

0 comments on commit ffdbde9

Please sign in to comment.