Textual Improvements on Documentation
- Fix spelling errors / typos, - Remove deprecated command line options from doc.
This commit is contained in:
parent
4f5b223b60
commit
6791e9a2f8
@ -111,7 +111,7 @@ Instaloader supports the following targets:
|
|||||||
``profile`` (requires :option:`--login`).
|
``profile`` (requires :option:`--login`).
|
||||||
|
|
||||||
- ``-post``
|
- ``-post``
|
||||||
Replace **post** with the post's shortcode to download single post. Must be preceeded by ``--`` in
|
Replace **post** with the post's shortcode to download single post. Must be preceded by ``--`` in
|
||||||
the argument list to not be mistaken as an option flag::
|
the argument list to not be mistaken as an option flag::
|
||||||
|
|
||||||
instaloader -- -B_K4CykAOtf
|
instaloader -- -B_K4CykAOtf
|
||||||
|
@ -36,7 +36,7 @@ stores all posts along with the pictures's captions there.
|
|||||||
Re-Download the given object
|
Re-Download the given object
|
||||||
|
|
||||||
- ``+args.txt``
|
- ``+args.txt``
|
||||||
Read targets (and options) from given textfile. See :option:`+args.txt`.
|
Read targets (and options) from given text file. See :option:`+args.txt`.
|
||||||
|
|
||||||
What to Download of each Post
|
What to Download of each Post
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
@ -94,13 +94,6 @@ What to Download of each Post
|
|||||||
What to Download of each Profile
|
What to Download of each Profile
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
.. option:: --profile-pic-only, -P
|
|
||||||
|
|
||||||
.. deprecated:: 4.1
|
|
||||||
Use :option:`--no-posts`.
|
|
||||||
|
|
||||||
Only download profile picture.
|
|
||||||
|
|
||||||
.. option:: --no-posts
|
.. option:: --no-posts
|
||||||
|
|
||||||
Do not download regular posts.
|
Do not download regular posts.
|
||||||
@ -135,20 +128,6 @@ What to Download of each Profile
|
|||||||
|
|
||||||
.. versionadded:: 4.3
|
.. versionadded:: 4.3
|
||||||
|
|
||||||
.. option:: --stories-only
|
|
||||||
|
|
||||||
.. deprecated:: 4.1
|
|
||||||
Use :option:`--stories` :option:`--no-posts`.
|
|
||||||
|
|
||||||
Rather than downloading regular posts of each specified profile, only
|
|
||||||
download stories. Requires :option:`--login`. Does not imply
|
|
||||||
:option:`--no-profile-pic`.
|
|
||||||
|
|
||||||
.. note::
|
|
||||||
|
|
||||||
If possible, use ``:stories`` target rather than :option:`--stories-only`
|
|
||||||
with all your followees. ``:stories`` uses fewer API requests.
|
|
||||||
|
|
||||||
Which Posts to Download
|
Which Posts to Download
|
||||||
^^^^^^^^^^^^^^^^^^^^^^^
|
^^^^^^^^^^^^^^^^^^^^^^^
|
||||||
|
|
||||||
@ -257,19 +236,6 @@ How to Download
|
|||||||
to ``3``. If a connection fails, it can be manually skipped by hitting
|
to ``3``. If a connection fails, it can be manually skipped by hitting
|
||||||
:kbd:`Control-c`. Set this to ``0`` to retry infinitely.
|
:kbd:`Control-c`. Set this to ``0`` to retry infinitely.
|
||||||
|
|
||||||
.. option:: --commit-mode
|
|
||||||
|
|
||||||
Tries to ensure downloaded images avoid corruption in case of unexpected
|
|
||||||
interruption. If the last picture is corrupted, Instaloader will fix the
|
|
||||||
picture the next time it is run.
|
|
||||||
|
|
||||||
.. versionadded:: 4.2
|
|
||||||
|
|
||||||
.. warning::
|
|
||||||
We discourage from using the "commit mode" due to its bugs when being used
|
|
||||||
with other command line options (e.g. :issue:`257` with
|
|
||||||
:option:`--fast-update` and :issue:`483` with :option:`--tagged`).
|
|
||||||
|
|
||||||
.. option:: --request-timeout N
|
.. option:: --request-timeout N
|
||||||
|
|
||||||
Seconds to wait before timing out a connection request.
|
Seconds to wait before timing out a connection request.
|
||||||
@ -289,7 +255,7 @@ Miscellaneous Options
|
|||||||
|
|
||||||
Read arguments from file `args.txt`, a shortcut to provide arguments from
|
Read arguments from file `args.txt`, a shortcut to provide arguments from
|
||||||
file rather than command-line. This provides a convenient way to hide login
|
file rather than command-line. This provides a convenient way to hide login
|
||||||
info from CLI, and can also be used to simplify managment of long arguments.
|
info from CLI, and can also be used to simplify management of long arguments.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
|
@ -94,7 +94,7 @@ Discussed in :issue:`113`.
|
|||||||
Top X Posts of User
|
Top X Posts of User
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
With Instaloader, it is easy to download the few most-liked pictres of a user.
|
With Instaloader, it is easy to download the few most-liked pictures of a user.
|
||||||
|
|
||||||
.. literalinclude:: codesnippets/194_top_x_of_user.py
|
.. literalinclude:: codesnippets/194_top_x_of_user.py
|
||||||
|
|
||||||
|
@ -10,7 +10,7 @@ Resumable Iterations
|
|||||||
:backlinks: none
|
:backlinks: none
|
||||||
|
|
||||||
For many download targets, Instaloader is able to resume a
|
For many download targets, Instaloader is able to resume a
|
||||||
previously-interrupted iteration. It provides an interruptable
|
previously-interrupted iteration. It provides an interruptible
|
||||||
Iterator :class:`NodeIterator` and a context manager
|
Iterator :class:`NodeIterator` and a context manager
|
||||||
:func:`resumable_iteration`, which we both present here.
|
:func:`resumable_iteration`, which we both present here.
|
||||||
|
|
||||||
|
@ -28,7 +28,7 @@ happen in normal conditions, consider adjusting the
|
|||||||
:option:`--max-connection-attempts` option.
|
:option:`--max-connection-attempts` option.
|
||||||
|
|
||||||
There have been observations that services, that in their nature offer
|
There have been observations that services, that in their nature offer
|
||||||
promiscious IP addresses, such as cloud, VPN and public proxy services, might be
|
promiscuous IP addresses, such as cloud, VPN and public proxy services, might be
|
||||||
subject to significantly stricter limits for anonymous access. However,
|
subject to significantly stricter limits for anonymous access. However,
|
||||||
logged-in accesses (see :option:`--login`) do not seem to be affected.
|
logged-in accesses (see :option:`--login`) do not seem to be affected.
|
||||||
|
|
||||||
@ -58,7 +58,7 @@ Nevertheless, in :issue:`92` and :issue:`615` users reported problems with
|
|||||||
logging in. We recommend to always keep the sessionfile which Instaloader
|
logging in. We recommend to always keep the sessionfile which Instaloader
|
||||||
creates when using :option:`--login`. If a sessionfile is present,
|
creates when using :option:`--login`. If a sessionfile is present,
|
||||||
:option:`--login` does not make make use of the failure-prone login procedure.
|
:option:`--login` does not make make use of the failure-prone login procedure.
|
||||||
Also, sessionfiles usually do not expire and can be copied between different
|
Also, session files usually do not expire and can be copied between different
|
||||||
computers without any problems.
|
computers without any problems.
|
||||||
|
|
||||||
If you do not have a sessionfile present, you may use the following script
|
If you do not have a sessionfile present, you may use the following script
|
||||||
@ -78,7 +78,7 @@ To use this script,
|
|||||||
|
|
||||||
#. Then, ``instaloader -l USERNAME`` should work fine.
|
#. Then, ``instaloader -l USERNAME`` should work fine.
|
||||||
|
|
||||||
This script also supports specifying a cookiefile path, which may be useful if
|
This script also supports specifying a cookie file path, which may be useful if
|
||||||
you use multiple Firefox profiles or if your operating system has the directory
|
you use multiple Firefox profiles or if your operating system has the directory
|
||||||
structure differently set up. Also, you can specify an alternative sessionfile
|
structure differently set up. Also, you can specify an alternative sessionfile
|
||||||
path.
|
path.
|
||||||
|
@ -730,9 +730,9 @@ class Instaloader:
|
|||||||
"""
|
"""
|
||||||
Download the Posts returned by given Post Iterator.
|
Download the Posts returned by given Post Iterator.
|
||||||
|
|
||||||
..versionadded:: 4.4
|
.. versionadded:: 4.4
|
||||||
|
|
||||||
..versionchanged:: 4.5
|
.. versionchanged:: 4.5
|
||||||
Transparently resume an aborted operation if `posts` is a :class:`NodeIterator`.
|
Transparently resume an aborted operation if `posts` is a :class:`NodeIterator`.
|
||||||
|
|
||||||
:param posts: Post Iterator to loop through.
|
:param posts: Post Iterator to loop through.
|
||||||
|
Loading…
x
Reference in New Issue
Block a user