sopel-irc / sopel

:robot::speech_balloon: An easy-to-use and highly extensible IRC Bot framework. Formerly Willie.
https://sopel.chat
Other
949 stars 403 forks source link

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

Closed SnoopJ closed 1 year ago

SnoopJ commented 1 year ago

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