mark/surplus
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

docs: fix english

Browse source 
oops
This commit is contained in:
Mark Joshwel 2023-09-05 04:34:12 +00:00
parent 762080c11d
commit 8ccee82f26
1 changed files with 12 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -89,7 +89,7 @@ options:
here are a few examples to get you quickly started using surplus in your own program: 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 ```python
>>> from surplus import surplus, Behaviour >>> from surplus import surplus, Behaviour
@ -98,7 +98,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' 'Ngee Ann Polytechnic\n535 Clementi Road\nBukit Timah\n599489\nNorthwest, Singapore'
``` ```
2. handle queries seperately 2. handle queries separately
```python ```python
>>> import surplus >>> import surplus
@ -123,7 +123,7 @@ here are a few examples to get you quickly started using surplus in your own pro
notes: 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 object
- most surplus functions return a [`Result`](#class-result) object. while you can - most surplus functions return a [`Result`](#class-result) object. while you can
@ -175,7 +175,7 @@ the command to create an empty commit is `git commit --allow-empty`
### reporting incorrect output ### reporting incorrect output
> [!NOTE] > [!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. different output from the iOS Shortcuts app is expected, however incorrect output is not.
@ -189,13 +189,13 @@ and do the following:
function, which by default is OpenStreetMap Nominatim. function, which by default is OpenStreetMap Nominatim.
(_don't know what the above means? then you are using the default reverser._) (_don't know what the above means? then you are using the default reverser._)
also look at the [what counts as "incorrect"](#what-counts-as-incorrect) section also look at the ['what counts as "incorrect"'](#what-counts-as-incorrect) section
before moving on. before moving on.
2. include the erroneous query. 2. include the erroneous query.
(_the Plus Code/local code/latlong coord/query string you passed into surplus_) (_the Plus Code/local code/latlong coord/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` flag](#command-line-usage) passed to the surplus CLI or with
`debug=True` set in function calls. `debug=True` set in function calls.
@ -242,8 +242,9 @@ other examples that _should not_ be reported are:
- name of place is incorrect/different - name of place is incorrect/different
this may be due to incorrect data from the geolocator function, which is OpenStreetMap Nominatim by default. this may be due to incorrect data from the geocoder function, which is OpenStreetMap
in the case of Nominatim, it means that the data on OpenStreetMap is incorrect. 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 (_if so, then consider updating OpenStreetMap to help not just you, but other surplus
and OpenStreetMap users!_) and OpenStreetMap users!_)
@ -778,7 +779,7 @@ methods
#### `Latlong.__str__()` #### `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` `self.longitude`
- signature - signature
@ -1078,12 +1079,12 @@ pluscodes 2022.1.3 Compute Plus Codes (Open Location Codes).
- [geopy](https://pypi.org/project/geopy/): - [geopy](https://pypi.org/project/geopy/):
Python Geocoding Toolbox Python Geocoding Toolbox
MIT License MIT Licence
- [geographiclib](https://pypi.org/project/geographiclib/): - [geographiclib](https://pypi.org/project/geographiclib/):
The geodesic routines from GeographicLib The geodesic routines from GeographicLib
MIT License MIT Licence
- [pluscodes](https://pypi.org/project/pluscodes/): - [pluscodes](https://pypi.org/project/pluscodes/):
Compute Plus Codes (Open Location Codes) Compute Plus Codes (Open Location Codes)