From 4a04c09f314e10a4db8f35bf1ecc10e4d0203223 Mon Sep 17 00:00:00 2001 From: Sean Breckenridge Date: Fri, 9 Jul 2021 14:54:50 -0700 Subject: [PATCH] docs: fix copy-paste errors/spelling mistakes --- CHANGELOG.md | 2 +- doc/MODULE_DESIGN.org | 2 +- my/core/__main__.py | 12 ++++++------ my/core/query_range.py | 2 +- tests/config.py | 2 +- tests/serialize_simplejson.py | 2 +- tox.ini | 2 +- 7 files changed, 12 insertions(+), 12 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b2a9e2..edaaf02 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -23,7 +23,7 @@ Modules: - some innitial work on filling **InfluxDB** with HPI data - pinboard - - 42399f6250d9901d93dcedcfe05f7857babcf834: **breaking backwards compability**, use pinbexport module directy + - 42399f6250d9901d93dcedcfe05f7857babcf834: **breaking backwards compatibility**, use pinbexport module directly Use 'hpi module install my.pinboard' to install it diff --git a/doc/MODULE_DESIGN.org b/doc/MODULE_DESIGN.org index a238342..b6f31f0 100644 --- a/doc/MODULE_DESIGN.org +++ b/doc/MODULE_DESIGN.org @@ -129,7 +129,7 @@ There is no limit to how many directories you could install into a single namesp There are some other users [[https://github.com/hpi/hpi][who have begun publishing their own modules]] as namespace packages, which you could potentially install and use, in addition to this repository, if any of those interest you. -Though, enabling this many modules may make ~hpi doctor~ look pretty busy. You can explicilty choose to enable/disable modules with a list of modules/regexes in your [[https://github.com/karlicoss/HPI/blob/f559e7cb899107538e6c6bbcf7576780604697ef/my/core/core_config.py#L24-L55][core config]], see [[https://github.com/seanbreckenridge/dotfiles/blob/a1a77c581de31bd55a6af3d11b8af588614a207e/.config/my/my/config/__init__.py#L42-L72][here]] for an example. +Though, enabling this many modules may make ~hpi doctor~ look pretty busy. You can explicitly choose to enable/disable modules with a list of modules/regexes in your [[https://github.com/karlicoss/HPI/blob/f559e7cb899107538e6c6bbcf7576780604697ef/my/core/core_config.py#L24-L55][core config]], see [[https://github.com/seanbreckenridge/dotfiles/blob/a1a77c581de31bd55a6af3d11b8af588614a207e/.config/my/my/config/__init__.py#L42-L72][here]] for an example. You may use the other modules or [[https://github.com/karlicoss/hpi-personal-overlay][my overlay]] as reference, but python packaging is already a complicated issue, before adding complexities like namespace packages and editable installs on top of it... If you're having trouble extending HPI in this fashion, you can open an issue here, preferably with a link to your code/repository and/or ~setup.py~ you're trying to use. diff --git a/my/core/__main__.py b/my/core/__main__.py index d101fe5..de97f8c 100644 --- a/my/core/__main__.py +++ b/my/core/__main__.py @@ -335,7 +335,7 @@ def _ui_getchar_pick(choices: Sequence[str], prompt: str = 'Select from: ') -> i Basic menu allowing the user to select one of the choices returns the index the user chose ''' - assert len(choices) > 0, 'Didnt recieve any choices to prompt!' + assert len(choices) > 0, 'Didnt receive any choices to prompt!' eprint(prompt + '\n') # prompts like 1,2,3,4,5,6,7,8,9,a,b,c,d,e,f... @@ -451,7 +451,7 @@ def query_hpi_functions( for item in res: # use sys.stdout directly # the overhead form click.echo isn't a *lot*, but when called in a loop - # with potentially millions of items it makes a noticable difference + # with potentially millions of items it makes a noticeable difference sys.stdout.write(dumps(item)) sys.stdout.write('\n') sys.stdout.flush() @@ -627,19 +627,19 @@ def module_install_cmd(user: bool, module: str) -> None: @click.option('--drop-unsorted', default=False, is_flag=True, - help="If the order an item can't be determined while ordering, drop those items from the results") + help="if the order of an item can't be determined while ordering, drop those items from the results") @click.option('--wrap-unsorted', default=False, is_flag=True, - help="If the order an item can't be determined while ordering, drop those items from the results") + help="if the order of an item can't be determined while ordering, wrap them into an 'Unsortable' object") @click.option('--raise-exceptions', default=False, is_flag=True, - help="If any errors are returned (as objects, not raised) from the functions, raise them") + help="if any errors are returned (as objects, not raised) from the functions, raise them") @click.option('--drop-exceptions', default=False, is_flag=True, - help='Ignore any errors returned as objects from the functions') + help='ignore any errors returned as objects from the functions') @click.argument('FUNCTION_NAME', nargs=-1, required=True) def query_cmd( function_name: Sequence[str], diff --git a/my/core/query_range.py b/my/core/query_range.py index 1b8f040..480c174 100644 --- a/my/core/query_range.py +++ b/my/core/query_range.py @@ -247,7 +247,7 @@ def _create_range_filter( else: # only specified within, default before to now if default_before is None: - raise QueryException("Only recieved a range length, with no start or end point to compare against") + raise QueryException("Only received a range length, with no start or end point to compare against") allow_after = default_before - within return ov >= allow_after and ov < default_before diff --git a/tests/config.py b/tests/config.py index 6abe014..49138c3 100644 --- a/tests/config.py +++ b/tests/config.py @@ -66,7 +66,7 @@ def test_user_config() -> None: from my.core.common import classproperty class user_config: param1 = 'abacaba' - # TOOD fuck. properties don't work here??? + # TODO fuck. properties don't work here??? @classproperty def param2(cls) -> int: return 456 diff --git a/tests/serialize_simplejson.py b/tests/serialize_simplejson.py index 9bff052..d421a15 100644 --- a/tests/serialize_simplejson.py +++ b/tests/serialize_simplejson.py @@ -1,6 +1,6 @@ ''' This file should only run when simplejson is installed, -but orjson is not installed to check compatability +but orjson is not installed to check compatibility ''' # none of these should fail diff --git a/tox.ini b/tox.ini index 66170d7..770198c 100644 --- a/tox.ini +++ b/tox.ini @@ -51,7 +51,7 @@ commands = # ignore some tests which might take a while to run on ci.. --ignore tests/takeout.py \ --ignore tests/extra/polar.py \ - # dont run simplejson compatability test since orjson is now installed + # dont run simplejson compatibility test since orjson is now installed --ignore tests/serialize_simplejson.py {posargs}