* page sizing changes

* docs
This commit is contained in:
Michael H 2020-01-10 06:43:35 -05:00 committed by GitHub
parent 2bb9b87db9
commit deab24e916
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 25 additions and 12 deletions

View File

@ -1,5 +1,19 @@
.. 3.2.x Changelogs .. 3.2.x Changelogs
Redbot 3.2.2 (2020-01-10)
=========================
Hotfixes
--------
- Fix Help Pagination issue
Docs
----
- Correct venv docs
Redbot 3.2.1 (2020-01-10) Redbot 3.2.1 (2020-01-10)
========================= =========================

View File

@ -38,7 +38,7 @@ to keep it in a location which is easy to type out the path to. From now, we'll
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
Create your virtual environment with the following command:: Create your virtual environment with the following command::
python3.7 -m venv redenv python3.8 -m venv redenv
And activate it with the following command:: And activate it with the following command::
@ -56,7 +56,7 @@ Continue reading `below <after-activating-virtual-environment>`.
~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~
Create your virtual environment with the following command:: Create your virtual environment with the following command::
py -3.7 -m venv redenv py -3.8 -m venv redenv
And activate it with the following command:: And activate it with the following command::
@ -82,7 +82,7 @@ Using ``pyenv virtualenv``
Using ``pyenv virtualenv`` saves you the headache of remembering where you installed your virtual Using ``pyenv virtualenv`` saves you the headache of remembering where you installed your virtual
environments. If you haven't already, install pyenv with `pyenv-installer`_. environments. If you haven't already, install pyenv with `pyenv-installer`_.
First, ensure your pyenv interpreter is set to python 3.7.0 or greater with the following command:: First, ensure your pyenv interpreter is set to python 3.8.1 or greater with the following command::
pyenv version pyenv version

View File

@ -193,7 +193,7 @@ def _update_event_loop_policy():
_asyncio.set_event_loop_policy(_uvloop.EventLoopPolicy()) _asyncio.set_event_loop_policy(_uvloop.EventLoopPolicy())
__version__ = "3.2.2.dev1" __version__ = "3.2.2"
version_info = VersionInfo.from_str(__version__) version_info = VersionInfo.from_str(__version__)
# Filter fuzzywuzzy slow sequence matcher warning # Filter fuzzywuzzy slow sequence matcher warning

View File

@ -223,7 +223,7 @@ class RedHelpFormatter:
shorten_line(f"**{name}** {command.short_doc}") shorten_line(f"**{name}** {command.short_doc}")
for name, command in sorted(subcommands.items()) for name, command in sorted(subcommands.items())
) )
for i, page in enumerate(pagify(subtext, page_length=1000, shorten_by=0)): for i, page in enumerate(pagify(subtext, page_length=500, shorten_by=0)):
if i == 0: if i == 0:
title = "**__Subcommands:__**" title = "**__Subcommands:__**"
else: else:
@ -281,12 +281,12 @@ class RedHelpFormatter:
f_len = len(f.value) + len(f.name) f_len = len(f.value) + len(f.name)
# Commands start at the 1st index of fields, i < 2 is a hacky workaround for now # Commands start at the 1st index of fields, i < 2 is a hacky workaround for now
if not current_count or f_len + current_count > max_chars or i < 2: if not current_count or f_len + current_count < max_chars or i < 2:
current_count += f_len current_count += f_len
curr_group.append(f) curr_group.append(f)
elif curr_group: elif curr_group:
ret.append(curr_group) ret.append(curr_group)
current_count = 0 current_count = f_len
curr_group = [f] curr_group = [f]
else: else:
if curr_group: if curr_group:
@ -299,7 +299,7 @@ class RedHelpFormatter:
pages = [] pages = []
page_char_limit = await ctx.bot._config.help.page_char_limit() page_char_limit = await ctx.bot._config.help.page_char_limit()
page_char_limit = min(page_char_limit, 5990) # Just in case someone was manually... page_char_limit = min(page_char_limit, 5500) # Just in case someone was manually...
author_info = {"name": f"{ctx.me.display_name} Help Menu", "icon_url": ctx.me.avatar_url} author_info = {"name": f"{ctx.me.display_name} Help Menu", "icon_url": ctx.me.avatar_url}
@ -318,13 +318,13 @@ class RedHelpFormatter:
# We could consider changing this to always just subtract the offset, # We could consider changing this to always just subtract the offset,
# But based on when this is being handled (very end of 3.2 release) # But based on when this is being handled (very end of 3.2 release)
# I'd rather not stick a major visual behavior change in at the last moment. # I'd rather not stick a major visual behavior change in at the last moment.
if page_char_limit + offset > 5990: if page_char_limit + offset > 5500:
# This is still neccessary with the max interaction above # This is still neccessary with the max interaction above
# While we could subtract 100% of the time the offset from page_char_limit # While we could subtract 100% of the time the offset from page_char_limit
# the intent here is to shorten again # the intent here is to shorten again
# *only* when neccessary, by the exact neccessary amount # *only* when neccessary, by the exact neccessary amount
# To retain a visual match with prior behavior. # To retain a visual match with prior behavior.
page_char_limit = 5990 - offset page_char_limit = 5500 - offset
elif page_char_limit < 250: elif page_char_limit < 250:
# Prevents an edge case where a combination of long cog help and low limit # Prevents an edge case where a combination of long cog help and low limit
# Could prevent anything from ever showing up. # Could prevent anything from ever showing up.
@ -393,7 +393,7 @@ class RedHelpFormatter:
shorten_line(f"**{name}** {command.short_doc}") shorten_line(f"**{name}** {command.short_doc}")
for name, command in sorted(coms.items()) for name, command in sorted(coms.items())
) )
for i, page in enumerate(pagify(command_text, page_length=1000, shorten_by=0)): for i, page in enumerate(pagify(command_text, page_length=500, shorten_by=0)):
if i == 0: if i == 0:
title = "**__Commands:__**" title = "**__Commands:__**"
else: else:

View File

@ -52,7 +52,6 @@ basepython = python3.8
extras = docs extras = docs
commands = commands =
sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out/html" -W -bhtml sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out/html" -W -bhtml
sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out/linkcheck" -W -blinkcheck
sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out/doctest" -W -bdoctest sphinx-build -d "{toxworkdir}/docs_doctree" docs "{toxworkdir}/docs_out/doctest" -W -bdoctest
[testenv:style] [testenv:style]