From 12d34143c296c55403f33cf34b74d3bddb271fa0 Mon Sep 17 00:00:00 2001 From: Alexander Graf Date: Wed, 30 Aug 2017 09:50:26 +0200 Subject: [PATCH] very minor documentation fixes --- README.rst | 12 ++---------- instaloader.py | 6 +++--- 2 files changed, 5 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index 7993c1a..f53a232 100644 --- a/README.rst +++ b/README.rst @@ -83,7 +83,7 @@ may specify the following targets: - ``:feed``: Your **feed** (requires ``--login``), -- ``@profile``: All profiles which are followed by ``profile``, i.e. the +- ``@profile``: All profiles that are followed by ``profile``, i.e. the *followees* of ``profile`` (requires ``--login``). Instaloader goes through all media matching the specified targets and @@ -332,7 +332,7 @@ a certain source. for post in loader.get_hashtag_posts('cat'): # post is an instance of instaloader.Post - self.download_post(post, target='#cat') + loader.download_post(post, target='#cat') Each Instagram profile has its own unique ID which stays unmodified even if a user changes his/her username. To get said ID, given the profile's @@ -342,14 +342,6 @@ name, you may call loader.get_id_by_username(PROFILE_NAME) -``get_followees()`` also returns unique IDs for all loaded followees. To -get the current username of a profile, given this unique ID -``get_username_by_id()`` can be used. For example: - -.. code:: python - - loader.get_username_by_id(loader.get_followees()[0]['id']) - .. as-module-intro-end Refer to the diff --git a/instaloader.py b/instaloader.py index 93fdb15..dce2a43 100755 --- a/instaloader.py +++ b/instaloader.py @@ -277,7 +277,7 @@ class Post: @property def caption_hashtags(self) -> List[str]: - """List of all hashtags (without preceeding #) which occur in the Post's caption.""" + """List of all hashtags (without preceeding #) that occur in the Post's caption.""" if not self.caption: return [] # This regular expression is from jStassen, adjusted to use Python's \w to support Unicode @@ -461,7 +461,7 @@ class Instaloader: session: Optional[requests.Session] = None, tries: int = 3) -> Dict[str, Any]: """JSON request to Instagram. - :param url: URL, relative to https://www.instagram.com/ + :param url: URL, relative to www.instagram.com/ :param params: GET parameters :param session: Session to use, or None to use self.session :param tries: Maximum number of attempts until an exception is raised @@ -770,7 +770,7 @@ class Instaloader: If filename is None, the file with the default session path is loaded. - :raises FileNotFoundError; If the file does not exist. + :raises FileNotFoundError: If the file does not exist. """ if filename is None: filename = get_default_session_filename(username)