Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Root module description is a mini-rant about LC_ALL rather than a description of the library #2493

Closed
SnoopJ opened this issue Jul 15, 2023 · 0 comments · Fixed by #2494
Closed
Labels
Documentation Easyfix Bugs or Tweaks that are easy for a new contributor to fix or implement Low Priority

Comments

@SnoopJ
Copy link
Contributor

SnoopJ commented Jul 15, 2023

Description

Looking at the sopel module with pydoc in an interactive prompt) exposes the user to a short rant about the behavior of LC_ALL and instructions to use only ASCII in this module.

I'm sympathetic to the frustration over #984 that led to this, but it will be an improvement to add a docstring to the module with a short description.

Reproduction steps

Run python3 -m pydoc sopel or import sopel; help(sopel) in an interactive prompt.

Expected behavior

The user should see a short description of Sopel

Relevant logs

No response

Notes

No response

Sopel version

c26914b

Installation method

pip install

Python version

No response

Operating system

No response

IRCd

No response

Relevant plugins

No response

@Exirel Exirel added Low Priority Easyfix Bugs or Tweaks that are easy for a new contributor to fix or implement labels Jul 15, 2023
@dgw dgw closed this as completed in #2494 Jul 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Easyfix Bugs or Tweaks that are easy for a new contributor to fix or implement Low Priority
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants