pybliometrics-dev / pybliometrics

Python-based API-Wrapper to access Scopus
https://pybliometrics.readthedocs.io/en/stable/
Other
407 stars 127 forks source link

add backticks into docstring (documentation) #289

Closed jpcaveiro closed 10 months ago

jpcaveiro commented 1 year ago

pybliometrics version: 3.5.2

Affected classes: AbstractRetrieval(Retrieval)

Expected behavior: Add backticks to description like description, and the same for abstract in a similar docstring, because "property description" could mean several things.

"""The abstract of a document.
Note: If this is empty, try property description instead.
"""
Michael-E-Rose commented 1 year ago

That's correct! Do you want to tackle this in a PR?

nils-herrmann commented 10 months ago

Integration of backticks into docstring should be complete.

Michael-E-Rose commented 10 months ago

Commit b7a2ec61eea3fcd8ccc5da1d442837a0fd280020