From 548a50b9844053e224bc6d93ab392c7530ef4be5 Mon Sep 17 00:00:00 2001 From: jack1142 <6032823+jack1142@users.noreply.github.com> Date: Fri, 15 Nov 2019 22:28:17 +0100 Subject: [PATCH] [Docs] Add information about ``info.json``'s ``min_python_version`` key in Downloader Framework page. (#3125) * docs(downloader): add missing `min_python_version` key * chore(changelog): add towncrier entry --- changelog.d/3124.docs.rst | 1 + docs/framework_downloader.rst | 3 +++ 2 files changed, 4 insertions(+) create mode 100644 changelog.d/3124.docs.rst diff --git a/changelog.d/3124.docs.rst b/changelog.d/3124.docs.rst new file mode 100644 index 000000000..3eb9e27a9 --- /dev/null +++ b/changelog.d/3124.docs.rst @@ -0,0 +1 @@ +Add information about ``info.json``'s ``min_python_version`` key in Downloader Framework docs. \ No newline at end of file diff --git a/docs/framework_downloader.rst b/docs/framework_downloader.rst index e7b3de700..c1feb9ed9 100644 --- a/docs/framework_downloader.rst +++ b/docs/framework_downloader.rst @@ -35,6 +35,9 @@ Keys specific to the cog info.json (case sensitive) - ``max_bot_version`` (string) - Max version number of Red in the format ``MAJOR.MINOR.MICRO``, if ``min_bot_version`` is newer than ``max_bot_version``, ``max_bot_version`` will be ignored +- ``min_python_version`` (list of integers) - Min version number of Python + in the format ``[MAJOR, MINOR, PATCH]`` + - ``hidden`` (bool) - Determines if a cog is visible in the cog list for a repo. - ``disabled`` (bool) - Determines if a cog is available for install.