RepoMirrors
/
nvchecker
mirror of https://github.com/lilydjwg/nvchecker
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

better documentation on optional dependencies 

fixes #225.
[skip ci]
This commit is contained in:
lilydjwg 2023-06-02 00:43:49 +08:00
parent ac57d8fd15
commit d3603fcee8
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/usage.rst
View File

@ -327,7 +327,8 @@ post_data_type
(*Optional*) Specifies the ``Content-Type`` of the request body (``post_data``). By default, this is ``application/x-www-form-urlencoded``. (*Optional*) Specifies the ``Content-Type`` of the request body (``post_data``). By default, this is ``application/x-www-form-urlencoded``.
.. note:: .. note::
An additional dependency "lxml" is required. An additional dependency "lxml" is required.
You can use ``pip install 'nvchecker[htmlparser]'``.
Find with a Command Find with a Command
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
@ -536,6 +537,10 @@ pypi
use_pre_release use_pre_release
Whether to accept pre release. Default is false. Whether to accept pre release. Default is false.
.. note::
An additional dependency "packaging" is required.
You can use ``pip install 'nvchecker[pypi]'``.
Check RubyGems Check RubyGems
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
:: ::
@ -874,6 +879,9 @@ strip_release
provided provided
Instead of the package version, return the version this package provides. Its value is what the package provides, and ``strip_release`` takes effect too. This is best used with libraries. Instead of the package version, return the version this package provides. Its value is what the package provides, and ``strip_release`` takes effect too. This is best used with libraries.
.. note::
An additional dependency "pyalpm" is required.
Check ALPM files database Check ALPM files database
~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~
:: ::