diff --git a/readchar/_config.py b/readchar/_config.py index 2658d32..f744efe 100644 --- a/readchar/_config.py +++ b/readchar/_config.py @@ -4,7 +4,7 @@ class config: - """Static class that containes Constants used throughout the libary. + """Static class that contains Constants used throughout the library. You can directly use the class-attributes, do not create instances of it!""" def __new__(cls): diff --git a/readchar/_posix_key.py b/readchar/_posix_key.py index 5b2d74b..a3cdbcd 100644 --- a/readchar/_posix_key.py +++ b/readchar/_posix_key.py @@ -18,7 +18,7 @@ PAGE_UP = "\x1b\x5b\x35\x7e" PAGE_DOWN = "\x1b\x5b\x36\x7e" -# funcion keys +# function keys F1 = "\x1b\x4f\x50" F2 = "\x1b\x4f\x51" F3 = "\x1b\x4f\x52" diff --git a/readchar/_win_key.py b/readchar/_win_key.py index f02934a..d91a55f 100644 --- a/readchar/_win_key.py +++ b/readchar/_win_key.py @@ -27,7 +27,7 @@ PAGE_UP = "\x00\x49" PAGE_DOWN = "\x00\x51" -# funcion keys +# function keys F1 = "\x00\x3b" F2 = "\x00\x3c" F3 = "\x00\x3d" diff --git a/readchar/key.py b/readchar/key.py index 356af73..359f3f0 100644 --- a/readchar/key.py +++ b/readchar/key.py @@ -1,6 +1,6 @@ # flake8: noqa E401,E403 -# this file exists only for backwards compatability -# it allow the use of `import readchar.key` +# this file exists only for backwards compatibility +# it allows the use of `import readchar.key` from . import platform diff --git a/tests/manual-test.py b/tests/manual-test.py index 9c35649..5c8f5f6 100644 --- a/tests/manual-test.py +++ b/tests/manual-test.py @@ -1,3 +1,4 @@ +# flake8: noqa E231 from readchar import key, readkey