From 7f308f308b02cc09edbd149548406f5b41ab664e Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Sat, 3 Jul 2021 13:15:33 +1000 Subject: [PATCH] docs: fix a few simple typos There are small typos in: - CONTRIBUTING.md - README.md - gpxpy/gpx.py Fixes: - Should read `containing` rather than `containint`. - Should read `specified` rather than `specificed`. - Should read `issue` rather than `inssue`. - Should read `access` rather than `acess`. Closes #235 --- CONTRIBUTING.md | 2 +- README.md | 2 +- gpxpy/gpx.py | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 33a42896..5f4649bd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ Please include tests for new features. Tests or documentation without bug fixes - Run the test suite on both Python 2.x and 3.x. You can enable [Travis CI](https://travis-ci.org/profile/) on your repo to catch test failures prior to the pull request, and [Coveralls](https://coveralls.io) to see if the changed code is covered by tests. - Create a pull request to pull the changes from your branch to the gpxpy master. -If you plan a big refactory, open an inssue for discussion before starting it. +If you plan a big refactory, open an issue for discussion before starting it. ### Guidelines diff --git a/README.md b/README.md index d60ffe8e..d1fd7988 100644 --- a/README.md +++ b/README.md @@ -86,7 +86,7 @@ The GPX version is automatically determined when parsing by reading the version ## GPX max speed -Gpxpy is a GPX parser and by using it you have acess to all the data from the original GPX file. The additional methods to calculate stats have some additional heuristics to remove common GPS errors. For example, to calculate `max_speed` it removes the top `5%` of speeds and points with nonstandard distance (those are usually GPS errors). +Gpxpy is a GPX parser and by using it you have access to all the data from the original GPX file. The additional methods to calculate stats have some additional heuristics to remove common GPS errors. For example, to calculate `max_speed` it removes the top `5%` of speeds and points with nonstandard distance (those are usually GPS errors). "Raw" max speed can be calculated with: diff --git a/gpxpy/gpx.py b/gpxpy/gpx.py index 71520a86..0cfc6324 100644 --- a/gpxpy/gpx.py +++ b/gpxpy/gpx.py @@ -836,7 +836,7 @@ def join(self, track_segment: "GPXTrackSegment") -> None: self.points += track_segment.points def remove_point(self, point_no: int) -> None: - """ Removes a point specificed by index from the segment """ + """ Removes a point specified by index from the segment """ if point_no < 0 or point_no >= len(self.points): return @@ -1562,7 +1562,7 @@ def walk(self, only_points: bool=False) -> Iterator[Any]: #Union[GPXTrackPoint, point : GPXTrackPoint Point in the track segment_no : integer - Index of segment containint point. This is suppressed if only_points + Index of segment containing point. This is suppressed if only_points is True. point_no : integer Index of point. This is suppressed if only_points is True. @@ -2309,10 +2309,10 @@ def walk(self, only_points: bool=False) -> Iterator[Any]: point : GPXTrackPoint Point in the track track_no : integer - Index of track containint point. This is suppressed if only_points + Index of track containing point. This is suppressed if only_points is True. segment_no : integer - Index of segment containint point. This is suppressed if only_points + Index of segment containing point. This is suppressed if only_points is True. point_no : integer Index of point. This is suppressed if only_points is True.