search

pybliometrics-dev / pybliometrics

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

Docs: Missing docstrings for AbstractRetrieval #224

Closed astrochun closed 2 years ago

astrochun commented 2 years ago

I think the class' docstring is missing, isn't?

Originally posted by @Michael-E-Rose in https://github.com/pybliometrics-dev/pybliometrics/issues/222#issuecomment-989563260

Michael-E-Rose commented 2 years ago

Um, why a new issue for this? Should I wait merging PR #222 for another commit of yours?

astrochun commented 2 years ago

Um, why a new issue for this? Should I wait merging PR #222 for another commit of yours?

The purpose of #222 is to add ORCiD information to one of the property. Since the docstrings is entirely missing, this seems more like a separate issue as you're more familiar with AbstractRetrieval and your styling for docstrings.

Michael-E-Rose commented 2 years ago

I think that's a missunderstanding (see PR #222).

The class' docstring is in in __init__.

astrochun commented 2 years ago

I think that's a missunderstanding (see PR #222).

The class' docstring is in in __init__.

I see. Is there a reason why you have it in __init__ instead of having it associated at the top level with the class? I've often seen the latter, so an immediate search for the docs within my IDE was why I thought it was empty. Also, is there a reason why you have the "dunder" methods at the end? These are usually show in help near the top.

Michael-E-Rose commented 2 years ago

I think that's a question for @jkitchin :)