Merge pull request #134 from UniQP/fixTypos

xivk · web-flow · commit a19fefeaa9ec · 2022-11-29T09:29:01.000+01:00
Fix some typos
diff --git a/releasenotes/osmsharp-6.0.1.md b/releasenotes/osmsharp-6.0.1.md
@@ -8,7 +8,7 @@ New features:
 - Changed lat/lon to doubles instead of floats.
 - Writing compressed PBF.
 - Added other concepts apart from Nodes, Ways and Relations like Users to be better able to handle interactions with the OSM-API.
-- OsmSharp now includes .NET standard support, we now support `netstandard1.3` and `netstandard2.0`. We removed the PCL profiles because it was only there for Xamarin but that is now convered by .NET standard.
+- OsmSharp now includes .NET standard support, we now support `netstandard1.3` and `netstandard2.0`. We removed the PCL profiles because it was only there for Xamarin but that is now covered by .NET standard.
 - OsmSharp.Geo for now only supports .NET Framework 4.5 and up. Support for .NET standard is coming as soon as [NTS](https://github.com/NetTopologySuite/NetTopologySuite) releases a stable with support.
 - Support for extra root attributes in OSM-XML.
 - Better support for changesets:
diff --git a/releasenotes/osmsharp-6.1.0.md b/releasenotes/osmsharp-6.1.0.md
@@ -15,7 +15,7 @@ New features:
 - Changed lat/lon to doubles instead of floats.
 - Writing compressed PBF.
 - Added other concepts apart from Nodes, Ways and Relations like Users to be better able to handle interactions with the OSM-API.
-- OsmSharp now includes .NET standard support, we now support `netstandard1.3` and `netstandard2.0`. We removed the PCL profiles because it was only there for Xamarin but that is now convered by .NET standard.
+- OsmSharp now includes .NET standard support, we now support `netstandard1.3` and `netstandard2.0`. We removed the PCL profiles because it was only there for Xamarin but that is now covered by .NET standard.
 - OsmSharp.Geo for now only supports .NET Framework 4.5 and up. Support for .NET standard is coming as soon as [NTS](https://github.com/NetTopologySuite/NetTopologySuite) releases a stable with support.
 - Support for extra root attributes in OSM-XML.
 - Better support for changesets:
diff --git a/src/OsmSharp.Geo/DefaultFeatureInterpreter.cs b/src/OsmSharp.Geo/DefaultFeatureInterpreter.cs
@@ -126,9 +126,9 @@ public override FeatureCollection Interpret(ICompleteOsmGeo osmObject)
                     {
                         if (isArea)
                         { // area tags leads to simple polygon
-                            var lineairRing = new Feature(new LinearRing(coordinates.
+                            var linearRing = new Feature(new LinearRing(coordinates.
                                 ToArray<Coordinate>()), TagsAndIdToAttributes(osmObject));
-                            collection.Add(lineairRing);
+                            collection.Add(linearRing);
                         }
                         else
                         { // no area tag leads to just a line.
@@ -339,7 +339,7 @@ private Geometry GroupRings(List<KeyValuePair<bool, LinearRing>> rings)
                     if (multiPolygon == null &&
                         inners.Count == 0 &&
                         unused)
-                    { // there is just one lineair ring.
+                    { // there is just one linear ring.
                         geometry = outer;
                         break;
                     }
@@ -424,7 +424,7 @@ private bool AssignRings(List<KeyValuePair<bool, CompleteWay>> ways, bool[] assi
         }
 
         /// <summary>
-        /// Creates a new lineair ring from the given way and updates the assigned flags array.
+        /// Creates a new linear ring from the given way and updates the assigned flags array.
         /// </summary>
         private bool AssignRing(List<KeyValuePair<bool, CompleteWay>> ways, int way, bool[] assignedFlags, out LinearRing ring)
         {
diff --git a/src/OsmSharp.Geo/FeatureInterpreter.cs b/src/OsmSharp.Geo/FeatureInterpreter.cs
@@ -65,7 +65,7 @@ public static FeatureInterpreter DefaultInterpreter
         public abstract bool IsPotentiallyArea(TagsCollectionBase tags);
 
         /// <summary>
-        /// Interprets an OSM-object and returns the correctponding geometry.
+        /// Interprets an OSM-object and returns the corresponding geometry.
         /// </summary>
         public virtual FeatureCollection Interpret(OsmGeo osmGeo, ISnapshotDb data)
         {
diff --git a/src/OsmSharp.Geo/Streams/Features/IFeatureStreamSource.cs b/src/OsmSharp.Geo/Streams/Features/IFeatureStreamSource.cs
@@ -32,7 +32,7 @@ namespace OsmSharp.Geo.Streams
     public interface IFeatureStreamSource : IEnumerator<IFeature>, IEnumerable<IFeature>
     {
         /// <summary>
-        /// Intializes this source.
+        /// Initializes this source.
         /// </summary>
         /// <rremarks>Has to be called before starting read objects.</rremarks>
         void Initialize();
diff --git a/src/OsmSharp.Geo/Streams/Features/IFeatureStreamTarget.cs b/src/OsmSharp.Geo/Streams/Features/IFeatureStreamTarget.cs
@@ -31,7 +31,7 @@ namespace OsmSharp.Geo.Streams
     public interface IFeatureStreamTarget
     {
         /// <summary>
-        /// Intializes this target.
+        /// Initializes this target.
         /// </summary>
         /// <rremarks>Has to be called before starting to add objects.</rremarks>
         void Initialize();
diff --git a/src/OsmSharp.Geo/Streams/Features/Interpreted/InterpretedFeatureStreamSource.cs b/src/OsmSharp.Geo/Streams/Features/Interpreted/InterpretedFeatureStreamSource.cs
@@ -107,15 +107,15 @@ public void Close()
         }
 
         /// <summary>
-        /// Diposes of all native resource associated with this stream.
+        /// Disposes of all native resource associated with this stream.
         /// </summary>
         public void Dispose()
         {
 
         }
 
         /// <summary>
-        /// Returns a bounding box if avaible.
+        /// Returns a bounding box if available.
         /// </summary>
         /// <returns></returns>
         public Envelope GetBounds()
diff --git a/src/OsmSharp/API/Capabilities.cs b/src/OsmSharp/API/Capabilities.cs
@@ -90,7 +90,7 @@ public partial class Version
     public partial class Area
     {
         /// <summary>
-        /// Gets or sets the maxium.
+        /// Gets or sets the maximum.
         /// </summary>
         public double? Maximum { get; set; }
     }
@@ -101,7 +101,7 @@ public partial class Area
     public partial class NoteArea
     {
         /// <summary>
-        /// Gets or sets the maxium.
+        /// Gets or sets the maximum.
         /// </summary>
         public double? Maximum { get; set; }
     }
@@ -129,7 +129,7 @@ public partial class WayNodes
     }
 
     /// <summary>
-    /// Represents the API-changesets capabilitiy.
+    /// Represents the API-changesets capability.
     /// </summary>
     public partial class Changesets
     {
diff --git a/src/OsmSharp/API/User.cs b/src/OsmSharp/API/User.cs
@@ -80,7 +80,7 @@ public partial class User
         public int TraceCount { get; set; }
 
         /// <summary>
-        /// Gets or sets the blocks recieved.
+        /// Gets or sets the blocks received.
         /// </summary>
         public Block[] BlocksReceived { get; set; }
 
diff --git a/src/OsmSharp/Complete/Extensions.cs b/src/OsmSharp/Complete/Extensions.cs
@@ -237,7 +237,7 @@ public static OsmGeo[] ToSimpleWithChildren(this CompleteRelation relation)
             return withChildren.DistinctByGeoKey().ToArray();
         }
 
-        // Recursive, safe against circular references, may return duplciate nodes.
+        // Recursive, safe against circular references, may return duplicate nodes.
         private static IEnumerable<OsmGeo> ToSimpleWithChildrenCircularSafe(
             this CompleteRelation complete, HashSet<OsmGeoKey> seenGeoKeys)
         {
diff --git a/src/OsmSharp/Db/Impl/IHistoryDbImpl.cs b/src/OsmSharp/Db/Impl/IHistoryDbImpl.cs
@@ -52,7 +52,7 @@ public interface IHistoryDbImpl
         IEnumerable<OsmGeo> Get(IEnumerable<OsmGeoVersionKey> keys);
 
         /// <summary>
-        /// Gets allobjects with the given keys.
+        /// Gets all objects with the given keys.
         /// </summary>
         /// <returns>
         /// Objects sorted by type (node, way, relation) and then id and then version ascending.
diff --git a/src/OsmSharp/Db/Impl/MemoryHistoryDb.cs b/src/OsmSharp/Db/Impl/MemoryHistoryDb.cs
@@ -190,7 +190,7 @@ public IEnumerable<OsmGeo> GetWithArchived(IEnumerable<OsmGeoKey> keys)
         }
 
         /// <summary>
-        /// Gets all visbible objects within the given bounding box.
+        /// Gets all visible objects within the given bounding box.
         /// </summary>
         public IEnumerable<OsmGeo> Get(double minLatitude, double minLongitude, double maxLatitude, double maxLongitude)
         {
@@ -406,7 +406,7 @@ public OsmGeo Get(OsmGeoType type, long id)
                         return x.Id == id;
                     }).OrderBy(x => -x.Version).FirstOrDefault();
             }
-            throw new Exception(string.Format("Uknown OsmGeoType: {0}.",
+            throw new Exception(string.Format("Unknown OsmGeoType: {0}.",
                 type.ToInvariantString()));
         }
 
@@ -441,7 +441,7 @@ public OsmGeo Get(OsmGeoType type, long id, long version)
                     }
                     return relation;
             }
-            throw new Exception(string.Format("Uknown OsmGeoType: {0}.",
+            throw new Exception(string.Format("Unknown OsmGeoType: {0}.",
                 type.ToInvariantString()));
         }
         
diff --git a/src/OsmSharp/IO/Xml/API/Capabilities.Xml.cs b/src/OsmSharp/IO/Xml/API/Capabilities.Xml.cs
@@ -238,7 +238,7 @@ void IXmlSerializable.WriteXml(XmlWriter writer)
     }
 
     /// <summary>
-    /// Represents the API-changesets capabilitiy.
+    /// Represents the API-changesets capability.
     /// </summary>
     [XmlRoot("changesets")]
     public partial class Changesets : IXmlSerializable
diff --git a/src/OsmSharp/OsmGeo.cs b/src/OsmSharp/OsmGeo.cs
@@ -28,7 +28,7 @@
 namespace OsmSharp
 {
     /// <summary>
-    /// Primive used as a base class for any osm object that has a meaning on the map (Nodes, Ways and Relations).
+    /// Primitive used as a base class for any osm object that has a meaning on the map (Nodes, Ways and Relations).
     /// </summary>
     [JsonConverter(typeof(OsmGeoJsonConverter))]
     public abstract class OsmGeo : IComparable<OsmGeo>
diff --git a/src/OsmSharp/Streams/Complete/OsmToCompleteStreamSource.cs b/src/OsmSharp/Streams/Complete/OsmToCompleteStreamSource.cs
@@ -84,7 +84,7 @@ public override void Initialize()
 
             if (!_simpleSource.CanReset)
             { // the simple source cannot be reset, each object can be a child, no other option than caching everything!
-                // TODO: support this scenario, can be usefull when streaming data from a non-seekable stream.
+                // TODO: support this scenario, can be useful when streaming data from a non-seekable stream.
                 throw new NotSupportedException("Creating a complete stream from a non-resettable simple stream is not supported. Wrap the source stream and create a resettable stream.");
             }
             else
@@ -149,7 +149,7 @@ public override bool MoveNext()
                         }
                         break;
                     case OsmGeoType.Relation:
-                        // create complate relation.
+                        // create complete relation.
                         _current = (currentSimple as Relation).CreateComplete(_dataCache);
 
                         if (!_relationsToInclude.Contains(currentSimple.Id.Value))
diff --git a/src/OsmSharp/Streams/Filters/OsmStreamFilterMerge.cs b/src/OsmSharp/Streams/Filters/OsmStreamFilterMerge.cs
@@ -126,8 +126,8 @@ public override void RegisterSource(OsmStreamSource source)
         }
 
         private OsmGeo _current;
-        private bool? _source1Status = null; // false when finished, true when there is data, null when unintialized.
-        private bool? _source2Status = null; // false when finished, true when there is data, null when unintialized.
+        private bool? _source1Status = null; // false when finished, true when there is data, null when uninitialized.
+        private bool? _source2Status = null; // false when finished, true when there is data, null when uninitialized.
         private readonly ConflictResolutionType _resolutionType;
 
         /// <summary>
diff --git a/src/OsmSharp/Streams/OsmStreamExtensions.cs b/src/OsmSharp/Streams/OsmStreamExtensions.cs
@@ -42,7 +42,7 @@ public static void RegisterSource(this IOsmStreamTarget target, IEnumerable<OsmG
         }
 
         /// <summary>
-        /// Registers a source but keeps only the objects that satify a given condition.
+        /// Registers a source but keeps only the objects that satisfy a given condition.
         /// </summary>
         public static void RegisterSource(this IOsmStreamTarget target, IEnumerable<OsmGeo> source, Func<OsmGeo, bool> keep)
         {
diff --git a/test/OsmSharp.Test.Functional/PerformanceInfoConsumer.cs b/test/OsmSharp.Test.Functional/PerformanceInfoConsumer.cs
@@ -28,7 +28,7 @@
 namespace OsmSharp.Test.Functional
 {
     /// <summary>
-    /// A class that consumes perfomance information.
+    /// A class that consumes performance information.
     /// </summary>
     public class PerformanceInfoConsumer
     {
@@ -38,15 +38,15 @@ public class PerformanceInfoConsumer
         private long _memoryUsageLoggingDuration = 0; // Holds the time spent on logging memory usage.
 
         /// <summary>
-        /// Creates the a new performance info consumer.
+        /// Creates a new performance info consumer.
         /// </summary>
         public PerformanceInfoConsumer(string name)
         {
             _name = name;
         }
 
         /// <summary>
-        /// Creates the a new performance info consumer.
+        /// Creates a new performance info consumer.
         /// </summary>
         public PerformanceInfoConsumer(string name, int memUseLoggingInterval)
         {
diff --git a/test/OsmSharp.Test/Changesets/OsmChangeExtensionsTests.cs b/test/OsmSharp.Test/Changesets/OsmChangeExtensionsTests.cs
@@ -32,7 +32,7 @@ namespace OsmSharp.Test.Changesets
     public class OsmChangeExtensionsTests
     {
         /// <summary>
-        /// Tests squasing a single changeset.
+        /// Tests squashing a single changeset.
         /// </summary>
         [Test]
         public void TestSquashOneSet()
diff --git a/test/OsmSharp.Test/IO/Xml/API/OsmTests.cs b/test/OsmSharp.Test/IO/Xml/API/OsmTests.cs
@@ -378,7 +378,7 @@ public void TestDeserializePermissions()
         }
 
         /// <summary>
-        /// Test deserialization of XML that contains perferences.
+        /// Test deserialization of XML that contains preferences.
         /// </summary>
         [Test]
         public void TestDeserializePreferences()
diff --git a/test/OsmSharp.Test/Stream/PBFOsmStreamTargetTests.cs b/test/OsmSharp.Test/Stream/PBFOsmStreamTargetTests.cs
@@ -58,7 +58,7 @@ public void TestWriteNode()
                 sourceNode
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);
@@ -100,7 +100,7 @@ public void TestWriteNode()
                 sourceNode
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);
@@ -150,7 +150,7 @@ public void TestWriteNode()
                 sourceNode
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);
@@ -194,7 +194,7 @@ public void TestWriteWay()
                 sourceWay
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);
@@ -232,7 +232,7 @@ public void TestWriteWay()
                 sourceWay
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);
@@ -278,7 +278,7 @@ public void TestWriteWay()
                 sourceWay
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);
@@ -337,7 +337,7 @@ public void TestWriteRelation()
                 sourceRelation
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);
@@ -393,7 +393,7 @@ public void TestWriteRelation()
                 sourceRelation
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);
@@ -457,7 +457,7 @@ public void TestWriteRelation()
                 sourceRelation
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);
@@ -559,7 +559,7 @@ public void TestWriteMix()
                 sourceRelation
             };
 
-            // build pfb stream target.
+            // build PBF stream target.
             using (var stream = new MemoryStream())
             {
                 var target = new PBFOsmStreamTarget(stream);

Original file line number	Diff line number	Diff line change
`@@ -126,9 +126,9 @@ public override FeatureCollection Interpret(ICompleteOsmGeo osmObject)`
`126`	`126`	`{`
`127`	`127`	`if (isArea)`
`128`	`128`	`{ // area tags leads to simple polygon`
`129`		`- var lineairRing = new Feature(new LinearRing(coordinates.`
	`129`	`+ var linearRing = new Feature(new LinearRing(coordinates.`
`130`	`130`	`ToArray<Coordinate>()), TagsAndIdToAttributes(osmObject));`
`131`		`- collection.Add(lineairRing);`
	`131`	`+ collection.Add(linearRing);`
`132`	`132`	`}`
`133`	`133`	`else`
`134`	`134`	`{ // no area tag leads to just a line.`
`@@ -339,7 +339,7 @@ private Geometry GroupRings(List<KeyValuePair<bool, LinearRing>> rings)`
`339`	`339`	`if (multiPolygon == null &&`
`340`	`340`	`inners.Count == 0 &&`
`341`	`341`	`unused)`
`342`		`- { // there is just one lineair ring.`
	`342`	`+ { // there is just one linear ring.`
`343`	`343`	`geometry = outer;`
`344`	`344`	`break;`
`345`	`345`	`}`
`@@ -424,7 +424,7 @@ private bool AssignRings(List<KeyValuePair<bool, CompleteWay>> ways, bool[] assi`
`424`	`424`	`}`
`425`	`425`
`426`	`426`	`/// <summary>`
`427`		`- /// Creates a new lineair ring from the given way and updates the assigned flags array.`
	`427`	`+ /// Creates a new linear ring from the given way and updates the assigned flags array.`
`428`	`428`	`/// </summary>`
`429`	`429`	`private bool AssignRing(List<KeyValuePair<bool, CompleteWay>> ways, int way, bool[] assignedFlags, out LinearRing ring)`
`430`	`430`	`{`
Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,7 @@ public static FeatureInterpreter DefaultInterpreter`
`65`	`65`	`public abstract bool IsPotentiallyArea(TagsCollectionBase tags);`
`66`	`66`
`67`	`67`	`/// <summary>`
`68`		`- /// Interprets an OSM-object and returns the correctponding geometry.`
	`68`	`+ /// Interprets an OSM-object and returns the corresponding geometry.`
`69`	`69`	`/// </summary>`
`70`	`70`	`public virtual FeatureCollection Interpret(OsmGeo osmGeo, ISnapshotDb data)`
`71`	`71`	`{`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ namespace OsmSharp.Geo.Streams`
`32`	`32`	`public interface IFeatureStreamSource : IEnumerator<IFeature>, IEnumerable<IFeature>`
`33`	`33`	`{`
`34`	`34`	`/// <summary>`
`35`		`- /// Intializes this source.`
	`35`	`+ /// Initializes this source.`
`36`	`36`	`/// </summary>`
`37`	`37`	`/// <rremarks>Has to be called before starting read objects.</rremarks>`
`38`	`38`	`void Initialize();`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ namespace OsmSharp.Geo.Streams`
`31`	`31`	`public interface IFeatureStreamTarget`
`32`	`32`	`{`
`33`	`33`	`/// <summary>`
`34`		`- /// Intializes this target.`
	`34`	`+ /// Initializes this target.`
`35`	`35`	`/// </summary>`
`36`	`36`	`/// <rremarks>Has to be called before starting to add objects.</rremarks>`
`37`	`37`	`void Initialize();`
Original file line number	Diff line number	Diff line change
`@@ -107,15 +107,15 @@ public void Close()`
`107`	`107`	`}`
`108`	`108`
`109`	`109`	`/// <summary>`
`110`		`- /// Diposes of all native resource associated with this stream.`
	`110`	`+ /// Disposes of all native resource associated with this stream.`
`111`	`111`	`/// </summary>`
`112`	`112`	`public void Dispose()`
`113`	`113`	`{`
`114`	`114`
`115`	`115`	`}`
`116`	`116`
`117`	`117`	`/// <summary>`
`118`		`- /// Returns a bounding box if avaible.`
	`118`	`+ /// Returns a bounding box if available.`
`119`	`119`	`/// </summary>`
`120`	`120`	`/// <returns></returns>`
`121`	`121`	`public Envelope GetBounds()`
Original file line number	Diff line number	Diff line change
`@@ -90,7 +90,7 @@ public partial class Version`
`90`	`90`	`public partial class Area`
`91`	`91`	`{`
`92`	`92`	`/// <summary>`
`93`		`- /// Gets or sets the maxium.`
	`93`	`+ /// Gets or sets the maximum.`
`94`	`94`	`/// </summary>`
`95`	`95`	`public double? Maximum { get; set; }`
`96`	`96`	`}`
`@@ -101,7 +101,7 @@ public partial class Area`
`101`	`101`	`public partial class NoteArea`
`102`	`102`	`{`
`103`	`103`	`/// <summary>`
`104`		`- /// Gets or sets the maxium.`
	`104`	`+ /// Gets or sets the maximum.`
`105`	`105`	`/// </summary>`
`106`	`106`	`public double? Maximum { get; set; }`
`107`	`107`	`}`
`@@ -129,7 +129,7 @@ public partial class WayNodes`
`129`	`129`	`}`
`130`	`130`
`131`	`131`	`/// <summary>`
`132`		`- /// Represents the API-changesets capabilitiy.`
	`132`	`+ /// Represents the API-changesets capability.`
`133`	`133`	`/// </summary>`
`134`	`134`	`public partial class Changesets`
`135`	`135`	`{`
Original file line number	Diff line number	Diff line change
`@@ -237,7 +237,7 @@ public static OsmGeo[] ToSimpleWithChildren(this CompleteRelation relation)`
`237`	`237`	`return withChildren.DistinctByGeoKey().ToArray();`
`238`	`238`	`}`
`239`	`239`
`240`		`- // Recursive, safe against circular references, may return duplciate nodes.`
	`240`	`+ // Recursive, safe against circular references, may return duplicate nodes.`
`241`	`241`	`private static IEnumerable<OsmGeo> ToSimpleWithChildrenCircularSafe(`
`242`	`242`	`this CompleteRelation complete, HashSet<OsmGeoKey> seenGeoKeys)`
`243`	`243`	`{`