Improve documentation #185
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
A command to check if you already have the python2 module should probably be added to the docs. It should better explain that you may already have the python3 module as part of youtube-dl, but that tumblr-utils cannot use it. |
|
@bbolli I rebased and cleaned up this PR. Is it good to merge or should I close it? |
On many systems, python refers to Python 3.
Certain options should never be negative, and a count of zero should actually download zero posts, not all of them. Also, make sure we can read cookiefile before we back up any blogs. Included revisions: - Add check for confusing -i -n 0
Posts are now read from disk each time they are needed, instead of keeping them all in memory. This is especially needed when --save-notes is used with a large blog, as this often results in many gigabytes worth of HTML that does not fit into free memory all at once.
qsize() acquires a mutex on the queue, which is shared between threads. Read it only once to avoid a race condition.
Included revisions: - Make typing optional
Included revisions: - Saner non-option arguments
Included revisions: - Remove log_queue, better status and account logic - Better tracking and synchronization on ThreadPool.queue.qsize - Remove remaining_posts - Remove getting_tup - Put back the account parameter Fixes bbolli#169
Behaves similar to cp -u or or rsync when copying local files into the media directory. Included revisions: - Use prev_archive for style.css
Store the original exception instead of trying to reconstruct it later. The reference cycle can be avoided with traceback.clear_frames. Closes #12
- required dependencies are now assumed instead of using hacky fallbacks - optional dependencies are now listed in pyproject.toml
This is a python 2 thing.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've tried to improve the documentation somewhat, with the primary goal of having less new issues about things like youtube-dl, Python, and SSL errors. I renumbered some headings (as much as I like 0-based indexing) and removed some information that I found unnecessary and/or outdated.
For now I've left the beginner's guide alone, given the existing PR(s).