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.

Sign up for GitHub

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

docs: add docstring to library root module #2494

Merged
merged 2 commits into from
Jul 19, 2023
Merged

docs: add docstring to library root module #2494

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db051a1
docs: add docstring to library root module
SnoopJ Jul 15, 2023
393a22d
docs: remove outdated remarks about LC_ALL
SnoopJ Jul 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions sopel/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# ASCII ONLY IN THIS FILE THOUGH!!!!!!!
# Python does some stupid bullshit of respecting LC_ALL over the encoding on the
# file, so in order to undo Python's ridiculous fucking idiocy, we have to have
# our own check.
"""
Sopel is a simple, easy-to-use, open-source IRC utility bot, written in Python.

It’s designed to be easy to use, easy to run, and easy to extend.
"""
#
# Copyright 2008, Sean B. Palmer, inamidst.com
# Copyright 2012, Elsie Powell, http://embolalia.com
# Copyright 2012, Elad Alfassa <elad@fedoraproject.org>
Expand Down Expand Up @@ -37,9 +38,8 @@

loc = locale.getlocale()
if not loc[1] or ('UTF-8' not in loc[1] and 'utf8' not in loc[1]):
print('WARNING!!! You are running with a non-UTF8 locale environment '
'variable (e.g. LC_ALL is set to "C"), which makes Python 3 do '
'stupid things. If you get strange errors, please set it to '
print('Warning: Running with a non-UTF8 locale. If you see strange '
'encoding errors, try setting the LC_ALL environment variable to '
'something like "en_US.UTF-8".', file=sys.stderr)


Expand Down