Skip to content

Commit 9a269d4

Browse files
committed
LLM passed sphinx formating check
1 parent bcc5121 commit 9a269d4

1 file changed

Lines changed: 10 additions & 9 deletions

File tree

  • package/MDAnalysis/fetch

package/MDAnalysis/fetch/pdb.py

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ def from_DOI(doi, file_name, remove_prefix=True, cache_path=None):
195195
196196
Parameters
197197
----------
198-
doi: str
198+
doi : str
199199
The Digital Object Identifier (DOI) of the file(s) to download.
200200
file_name : str or list of str
201201
The name(s) of the file(s) to download from the repository.
@@ -221,14 +221,14 @@ def from_DOI(doi, file_name, remove_prefix=True, cache_path=None):
221221
For an invalid DOI link. See Notes for more information.
222222
223223
:class:`requests.exceptions.HTTPError`
224-
If an invalid file_name is specified.
224+
If an invalid ``file_name`` is specified.
225225
226226
Notes
227227
-----
228-
The DOI link, as specified by `doi`, should be in the format of
229-
"https://doi.org/..." or "doi.org/...".
228+
The DOI link, as specified by ``doi``, should be in the format of
229+
``"https://doi.org/..."`` or ``"doi.org/..."``.
230230
The function will automatically handle the prefix removal
231-
if `remove_prefix` is set to True.
231+
if ``remove_prefix`` is set to ``True``.
232232
233233
The current backend for downloading files is :class:`pooch.DOIDownloader`
234234
which only handles downloading from Zenodo and Figshare repositories.
@@ -239,17 +239,18 @@ def from_DOI(doi, file_name, remove_prefix=True, cache_path=None):
239239
Download a single DOI file:
240240
241241
>>> from_DOI("https://doi.org/10.6084/m9.figshare.5108170",
242-
... file_name="adk4AKE.psf")
242+
... file_name="adk4AKE.psf")
243243
'./MDAnalysis_pdbs/adk4AKE.psf'
244244
245245
>>> from_DOI("doi.org/10.6084/m9.figshare.5108170",
246-
... file_name="adk4AKE.psf")
246+
... file_name="adk4AKE.psf")
247247
'./MDAnalysis_pdbs/adk4AKE.psf'
248248
249-
249+
250250
Support pooch specified DOI format:
251+
251252
>>> from_DOI("doi:10.6084/m9.figshare.5108170",
252-
... file_name="adk4AKE.psf")
253+
... file_name="adk4AKE.psf")
253254
'./MDAnalysis_pdbs/adk4AKE.psf'
254255
255256
.. versionadded:: 2.11.0

0 commit comments

Comments
 (0)