Merge pull request #14 from Dissimilis/codex/find-and-improve-quality-of-life

Dissimilis · web-flow · commit 42e2ff025b91 · 2025-06-19T02:10:10.000+03:00
Improve docs and fix typos
diff --git a/README.md b/README.md
@@ -52,3 +52,12 @@ using (var file = File.Open("path_to_file", FileMode.Create))
     writer.Write(file);
 }
 ```
+
+## Building and testing
+
+The solution targets .NET 8.0. With the [.NET SDK](https://dotnet.microsoft.com/download) installed you can build and run all tests:
+
+```bash
+dotnet build
+dotnet test
+```
diff --git a/src/BookmarksManager/BookmarksManager.csproj b/src/BookmarksManager/BookmarksManager.csproj
@@ -10,9 +10,9 @@
     <PackageProjectUrl>https://github.com/Dissimilis/BookmarksManager</PackageProjectUrl>
     <Description>Library for handling browsers bookmarks (supports Netscape bookmarks format)</Description>
     <PackageTags>netscape;bookmarks;bookmark;favorites</PackageTags>
-    <PackageReleaseNotes>Ported to netstandard1.6; 
-Minor bugfixes; 
-Braking change: NetscapeBookmarksWritter renamed to NetscapeBookmarksWriter; </PackageReleaseNotes>
+    <PackageReleaseNotes>Ported to netstandard1.6;
+Minor bugfixes;
+Breaking change: NetscapeBookmarksWritter renamed to NetscapeBookmarksWriter; </PackageReleaseNotes>
     <RepositoryUrl>https://github.com/Dissimilis/BookmarksManager</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <RepositoryBranch>master</RepositoryBranch>
diff --git a/src/BookmarksManager/BookmarksWriterBase.cs b/src/BookmarksManager/BookmarksWriterBase.cs
@@ -16,8 +16,8 @@ protected BookmarksWriterBase(T bookmarksContainer)
         }
 
         /// <summary>
-        ///     Writes bookmarks to provided TextWritter. BookmarksWriter output encoding is not used in this method, you must
-        ///     create TextWriter with correct encoding
+        ///     Writes bookmarks to provided TextWriter. BookmarksWriter output encoding is not used in this method, you must
+        ///     create <see cref="TextWriter"/> with correct encoding
         /// </summary>
         protected abstract void Write(TextWriter outputTextWriter);
 
diff --git a/src/BookmarksManager/NetscapeFormat/NetscapeBookmarksWriter.cs b/src/BookmarksManager/NetscapeFormat/NetscapeBookmarksWriter.cs

Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ protected BookmarksWriterBase(T bookmarksContainer)`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`/// <summary>`
`19`		`- /// Writes bookmarks to provided TextWritter. BookmarksWriter output encoding is not used in this method, you must`
`20`		`- /// create TextWriter with correct encoding`
	`19`	`+ /// Writes bookmarks to provided TextWriter. BookmarksWriter output encoding is not used in this method, you must`
	`20`	`+ /// create <see cref="TextWriter"/> with correct encoding`
`21`	`21`	`/// </summary>`
`22`	`22`	`protected abstract void Write(TextWriter outputTextWriter);`
`23`	`23`