diff --git a/README.md b/README.md index e1fde69..eb52245 100644 --- a/README.md +++ b/README.md @@ -92,7 +92,7 @@ options: here are a few examples to get you quickly started using surplus in your own program: -1. let surplus do the heavy lifiting +1. let surplus do the heavy lifting ```python >>> from surplus import surplus, Behaviour @@ -101,7 +101,7 @@ here are a few examples to get you quickly started using surplus in your own pro 'Ngee Ann Polytechnic\n535 Clementi Road\nBukit Timah\n599489\nNorthwest, Singapore' ``` -2. handle queries seperately +2. handle queries separately ```python >>> import surplus @@ -126,7 +126,7 @@ here are a few examples to get you quickly started using surplus in your own pro notes: -- you can change what surplus does by passing in a custom [`Behaviour`](#class-behaviour) +- you can change what surplus does when passing in a custom [`Behaviour`](#class-behaviour) object - most surplus functions return a [`Result`](#class-result) object. while you can @@ -178,7 +178,7 @@ the command to create an empty commit is `git commit --allow-empty` ### reporting incorrect output > [!NOTE] -> this section is independent from the rest of the contributing section. +> this section is independent of the rest of the contributing section. different output from the iOS Shortcuts app is expected, however incorrect output is not. @@ -198,7 +198,7 @@ and do the following: 2. include the erroneous query. (_the Plus Code/local code/latlong coordinate/query string you passed into surplus_) -3. include output from the teminal with the +3. include output from the terminal with the [`--debug` flag](#command-line-usage) passed to the surplus CLI or with `debug=True` set in function calls. @@ -245,8 +245,9 @@ other examples that _should not_ be reported are: - name of place is incorrect/different - this may be due to incorrect data from the geolocator function, which is OpenStreetMap Nominatim by default. - in the case of Nominatim, it means that the data on OpenStreetMap is incorrect. + this may be due to incorrect data from the geocoder function, which is OpenStreetMap + Nominatim by default. in the case of Nominatim, it means that the data on OpenStreetMap + is incorrect. (_if so, then consider updating OpenStreetMap to help not just you, but other surplus and OpenStreetMap users!_) @@ -992,7 +993,7 @@ methods #### `Latlong.__str__()` -method that returns a comma-and-space-seperated string of `self.latitude` and +method that returns a comma-and-space-separated string of `self.latitude` and `self.longitude` - signature diff --git a/releaser.py b/releaser.py index e25c151..ed58520 100644 --- a/releaser.py +++ b/releaser.py @@ -38,10 +38,16 @@ path_surplus = Path(__file__).parent.joinpath("./surplus/surplus.py") build_time = datetime.now(timezone(timedelta(hours=8))) # using SGT insert_build_branch: str = run( - "git rev-parse --abbrev-ref HEAD", capture_output=True, text=True, shell=True + "git rev-parse --abbrev-ref HEAD", + capture_output=True, + text=True, + shell=True, ).stdout.strip("\n") insert_build_commit: str = run( - "git rev-parse HEAD", capture_output=True, text=True, shell=True + "git rev-parse HEAD", + capture_output=True, + text=True, + shell=True, ).stdout.strip("\n") insert_build_datetime: str = repr(build_time).replace("datetime.", "") diff --git a/surplus/surplus.py b/surplus/surplus.py index eff63e4..478f9a6 100644 --- a/surplus/surplus.py +++ b/surplus/surplus.py @@ -1605,7 +1605,7 @@ def cli() -> int: query = parse_query(behaviour=behaviour) if behaviour.debug: - print(f"debug: cli: {query=}") + print(f"debug: cli: {query=}", file=behaviour.stderr) if not query: print(f"error: {query.cry(string=not behaviour.debug)}", file=behaviour.stderr)