Minor doc fixes and improvements

README.rst

@@ -21,7 +21,7 @@
 
 ::
 
-    instaloader [--comments] [--geotags] [--stories] [--tagged]
+    instaloader [--comments] [--geotags] [--stories] [--highlights] [--tagged]
                 [--login YOUR-USERNAME] [--fast-update]
                 profile | "#hashtag" | :stories | :feed | :saved
 

docs/_static/style.css

@@ -22,3 +22,7 @@ a:hover {
 body {
     font-size: 16px;
 }
+
+.versionmodified {
+    font-size: 14px;
+}

docs/as-module.rst

@@ -144,6 +144,8 @@ Highlights
 
    Bases: :class:`Story`
 
+   .. versionadded:: 4.1
+
 Profiles
 """"""""
 

docs/basic-usage.rst

@@ -71,9 +71,16 @@ Instaloader supports the following targets:
    finds it by its unique ID and renames the folder accordingly.
 
    Besides the profile's posts, its current profile picture is downloaded. For
-   each profile you download, :option:`--stories` instructs Instaloader to also
-   **download the user's stories**, and :option:`--tagged` to **download posts
-   where the user is tagged**.
+   each profile you download,
+
+   - :option:`--stories`
+      instructs Instaloader to also **download the user's stories**,
+
+   - :option:`--highlights`
+      to **download highlights of each profile that is downloaded**, and
+
+   - :option:`--tagged`
+      to **download posts where the user is tagged**.
 
 - ``"#hashtag"``
    Posts with a certain **hashtag** (the quotes are usually necessary),

docs/cli-options.rst

@@ -106,6 +106,8 @@ What to Download of each Profile
 
    Do not download regular posts.
 
+   .. versionadded:: 4.1
+
 .. option:: --no-profile-pic
 
    Do not download profile picture.

docs/index.rst

@@ -41,7 +41,7 @@ See :ref:`install` for more options on how to install Instaloader.
 
 ::
 
-    instaloader [--comments] [--geotags] [--stories] [--tagged]
+    instaloader [--comments] [--geotags] [--stories] [--highlights] [--tagged]
                 [--login YOUR-USERNAME] [--fast-update]
                 profile | "#hashtag" |
                 :stories | :feed | :saved

instaloader/__main__.py

@@ -18,7 +18,7 @@ def usage_string():
     argv0 = os.path.basename(sys.argv[0])
     argv0 = "instaloader" if argv0 == "__main__.py" else argv0
     return """
-{0} [--comments] [--geotags] [--stories] [--tagged]
+{0} [--comments] [--geotags] [--stories] [--highlights] [--tagged]
 {2:{1}} [--login YOUR-USERNAME] [--fast-update]
 {2:{1}} profile | "#hashtag" | :stories | :feed | :saved
 {0} --help""".format(argv0, len(argv0), '')

instaloader/instaloader.py

@@ -717,6 +717,8 @@ class Instaloader:
     def save_profile_id(self, profile: Profile):
         """
         Store ID of profile locally.
+
+        .. versionadded:: 4.0.6
         """
         os.makedirs(self.dirname_pattern.format(profile=profile.username,
                                                 target=profile.username), exist_ok=True)
@@ -781,7 +783,7 @@ class Instaloader:
         :param profile_pic: not :option:`--no-profile-pic`.
         :param posts: not :option:`--no-posts`.
         :param tagged: :option:`--tagged`.
-        :param highlights: :option: `--highlights`.
+        :param highlights: :option:`--highlights`.
         :param stories: :option:`--stories`.
         :param fast_update: :option:`--fast-update`.
         :param post_filter: :option:`--post-filter`.

instaloader/structures.py

@@ -574,7 +574,9 @@ class Profile:
 
     @property
     def profile_pic_url(self) -> str:
-        """Return URL of profile picture"""
+        """Return URL of profile picture
+
+        .. versionadded:: 4.0.3"""
         try:
             return self._iphone_struct['hd_profile_pic_url_info']['url']
         except (InstaloaderException, KeyError) as err:
@@ -889,8 +891,7 @@ class Highlight(Story):
     :param context: :class:`InstaloaderContext` instance used for additional queries if necessary.
     :param node: Dictionary containing the available information of the highlight as returned by Instagram.
     :param owner: :class:`Profile` instance representing the owner profile of the highlight.
-
-    .. versionadded:: 4.1"""
+    """
 
     def __init__(self, context: InstaloaderContext, node: Dict[str, Any], owner: Optional[Profile] = None):
         super().__init__(context, node)