mirror of
https://github.com/instaloader/instaloader.git
synced 2024-09-17 11:02:23 +02:00
very minor documentation fixes
This commit is contained in:
parent
7862bdb173
commit
12d34143c2
12
README.rst
12
README.rst
@ -83,7 +83,7 @@ may specify the following targets:
|
|||||||
|
|
||||||
- ``:feed``: Your **feed** (requires ``--login``),
|
- ``: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``).
|
*followees* of ``profile`` (requires ``--login``).
|
||||||
|
|
||||||
Instaloader goes through all media matching the specified targets and
|
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'):
|
for post in loader.get_hashtag_posts('cat'):
|
||||||
# post is an instance of instaloader.Post
|
# 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
|
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
|
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)
|
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
|
.. as-module-intro-end
|
||||||
|
|
||||||
Refer to the
|
Refer to the
|
||||||
|
@ -277,7 +277,7 @@ class Post:
|
|||||||
|
|
||||||
@property
|
@property
|
||||||
def caption_hashtags(self) -> List[str]:
|
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:
|
if not self.caption:
|
||||||
return []
|
return []
|
||||||
# This regular expression is from jStassen, adjusted to use Python's \w to support Unicode
|
# 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]:
|
session: Optional[requests.Session] = None, tries: int = 3) -> Dict[str, Any]:
|
||||||
"""JSON request to Instagram.
|
"""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 params: GET parameters
|
||||||
:param session: Session to use, or None to use self.session
|
:param session: Session to use, or None to use self.session
|
||||||
:param tries: Maximum number of attempts until an exception is raised
|
: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.
|
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:
|
if filename is None:
|
||||||
filename = get_default_session_filename(username)
|
filename = get_default_session_filename(username)
|
||||||
|
Loading…
Reference in New Issue
Block a user