Skip to content

Commit

Permalink
docs: update example filenames in configuration.py
Browse files Browse the repository at this point in the history
  • Loading branch information
Ljzd-PRO committed Jan 23, 2025
1 parent b20d017 commit 1c9e612
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions ktoolbox/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -169,15 +169,15 @@ class JobConfiguration(BaseModel):
:ivar count: Number of coroutines for concurrent download
:ivar post_dirname_format: Customize the post directory name format, you can use some of the \
[properties][ktoolbox.configuration.JobConfiguration] in ``Post``. \
e.g. ``[{published}]{id}`` > ``[2024-1-1]123123``, ``{user}_{published}_{title}`` > ``234234_2024-1-1_HelloWorld``
e.g. ``[{published}]{id}`` > ``[2024-1-1]123123``, ``{user}_{published}_{title}`` > ``234234_2024-1-1_TheTitle``
:ivar post_structure: Post path structure
:ivar mix_posts: Save all files from different posts at same path in creator directory. \
It would not create any post directory, and ``CreatorIndices`` would not been recorded.
:ivar sequential_filename: Rename attachments in numerical order, e.g. ``1.png``, ``2.png``, ...
:ivar filename_format: Customize the filename format by inserting an empty ``{}`` to represent the basic filename.
Similar to post_dirname_format, you can use some of the [properties][ktoolbox.configuration.JobConfiguration] \
in Post. For example: ``{title}_{}`` could result in filenames like \
``HelloWorld_b4b41de2-8736-480d-b5c3-ebf0d917561b``, ``HelloWorld_af349b25-ac08-46d7-98fb-6ce99a237b90``, etc. \
``TheTitle_b4b41de2-8736-480d-b5c3-ebf0d917561b``, ``TheTitle_af349b25-ac08-46d7-98fb-6ce99a237b90``, etc. \
You can also use it with ``sequential_filename``. For instance, \
``[{published}]_{}`` could result in filenames like ``[2024-1-1]_1.png``, ``[2024-1-1]_2.png``, etc.
:ivar allow_list: Download files which match these patterns (Unix shell-style), e.g. ``["*.png"]``
Expand Down

0 comments on commit 1c9e612

Please sign in to comment.