Minor documentation improvements
- List all __init__ methods in documentation - Further describe purpose of Profile in its docstring
This commit is contained in:
parent
760688d9e6
commit
4a2e32790a
11
docs/conf.py
11
docs/conf.py
@ -362,3 +362,14 @@ current_release = subprocess.check_output(["git", "describe", "--abbrev=0"]).dec
|
|||||||
current_release_date = subprocess.check_output(["git", "log", "-1", "--tags", "--format=%ad", "--date=format:%e %b %Y"]).decode("ascii")[:-1]
|
current_release_date = subprocess.check_output(["git", "log", "-1", "--tags", "--format=%ad", "--date=format:%e %b %Y"]).decode("ascii")[:-1]
|
||||||
|
|
||||||
html_context = {'current_release': current_release, 'current_release_date': current_release_date}
|
html_context = {'current_release': current_release, 'current_release_date': current_release_date}
|
||||||
|
|
||||||
|
|
||||||
|
def skip(app, what, name, obj, skip, options):
|
||||||
|
# Ensure constructors are documented
|
||||||
|
if name == "__init__":
|
||||||
|
return False
|
||||||
|
return skip
|
||||||
|
|
||||||
|
|
||||||
|
def setup(app):
|
||||||
|
app.connect('autodoc-skip-member', skip)
|
||||||
|
@ -427,6 +427,9 @@ class Profile:
|
|||||||
"""
|
"""
|
||||||
An Instagram Profile.
|
An Instagram Profile.
|
||||||
|
|
||||||
|
Provides methods for accessing profile properties, as well as :meth:`Profile.get_posts` and for own profile
|
||||||
|
:meth:`Profile.get_saved_posts`.
|
||||||
|
|
||||||
Instances are linked to an :class:`Instaloader` instance. This class implements == and is hashable.
|
Instances are linked to an :class:`Instaloader` instance. This class implements == and is hashable.
|
||||||
"""
|
"""
|
||||||
def __init__(self, instaloader: 'Instaloader', identifier: Union[str, int]):
|
def __init__(self, instaloader: 'Instaloader', identifier: Union[str, int]):
|
||||||
@ -603,6 +606,7 @@ class Instaloader:
|
|||||||
download_comments: Tristate = Tristate.no_extra_query,
|
download_comments: Tristate = Tristate.no_extra_query,
|
||||||
save_metadata: Tristate = Tristate.never,
|
save_metadata: Tristate = Tristate.never,
|
||||||
max_connection_attempts: int = 3):
|
max_connection_attempts: int = 3):
|
||||||
|
"""Instaloader."""
|
||||||
|
|
||||||
# configuration parameters
|
# configuration parameters
|
||||||
self.user_agent = user_agent if user_agent is not None else default_user_agent()
|
self.user_agent = user_agent if user_agent is not None else default_user_agent()
|
||||||
|
Loading…
Reference in New Issue
Block a user