Update some comments for consistency

menees · Oct 14, 2023 · 9a3d4f4 · 9a3d4f4
1 parent 745ce23
commit 9a3d4f4
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -91,7 +91,7 @@ The library also contains some helper classes for specialized parsing situtation
 * [Lexer](src/Menees.Chords/Parsers/Lexer.cs)
 
 ## Applications
-* **Web**: The [Menees Chord Sheet Converter](http://chords.menees.com/) web application converts [Ultimate Guitar](https://www.ultimate-guitar.com/)-style chord-over-text sheets into [ChordPro](https://www.chordpro.org/) format or [MobileSheets](https://www.zubersoft.com/mobilesheets/) format. The converter is a Blazor WebAssembly app, so it needs to be run in a modern, up-to-date web browser.
+* **Web**: The [Menees Chord Sheet Converter](http://chords.menees.com/) web application converts [Ultimate Guitar](https://www.ultimate-guitar.com/)-style chords-over-text sheets into [ChordPro](https://www.chordpro.org/) format or [MobileSheets](https://www.zubersoft.com/mobilesheets/) format. The converter is a Blazor WebAssembly app, so it needs to be run in a modern, up-to-date web browser.
 * **Console**: The `.\Menees.Chords.Cli.exe` .NET console application is a thin wrapper over the `Menees.Chords.dll` library.
 Run `.\Menees.Chords.Cli.exe --help` to see its available commands and options. Its primary command is `convert`.
 Run `.\Menees.Chords.Cli.exe convert --help` to see its arguments and options.

diff --git a/src/Menees.Chords.Web/MainLayout.razor b/src/Menees.Chords.Web/MainLayout.razor
@@ -8,7 +8,7 @@
                 <b>Menees Chord Sheet Converter @DisplayVersion</b>
             </div>
             <div class="px-4 description">
-                Convert <a href="https://www.ultimate-guitar.com/">Ultimate Guitar</a>-style chord-over-text sheets into
+                Convert <a href="https://www.ultimate-guitar.com/">Ultimate Guitar</a>-style chords-over-text sheets into
                 <a href="https://www.chordpro.org/">ChordPro</a> format.
             </div>
             <div>

diff --git a/src/Menees.Chords.Web/wwwroot/index.html b/src/Menees.Chords.Web/wwwroot/index.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no" />
     <title>Menees Chord Sheet Converter</title>
-    <meta name="description" content="Convert Ultimate Guitar-style chord-over-text sheets into ChordPro format.">
+    <meta name="description" content="Convert Ultimate Guitar-style chords-over-text sheets into ChordPro format.">
     <meta name="keywords" content="Ultimate Guitar, Ultimate-Guitar, ChordPro, MobileSheets">
     <base href="/" />
     <link href="css/bootstrap/bootstrap.min.css" rel="stylesheet" />

diff --git a/src/Menees.Chords/ChordProLyricLine.cs b/src/Menees.Chords/ChordProLyricLine.cs
@@ -196,6 +196,7 @@ void AddLyrics(int length)
 				default:
 					if (IsBracketed(segment.Text))
 					{
+						// Put bracketed ChordPro annotations like [*↑] or [*D*] in the chord line.
 						AppendChord(segment.Text, unbracketed => new TextSegment(unbracketed));
 					}
 					else

diff --git a/src/Menees.Chords/Parsers/DocumentParser.cs b/src/Menees.Chords/Parsers/DocumentParser.cs
@@ -86,7 +86,7 @@ public sealed class DocumentParser
 	/// </summary>
 	/// <remarks>
 	/// These are designed to process input that's in human-friendly formats like
-	/// "chord over text" or "Ultimate Guitar" format, but they can also process
+	/// "chords over text" or "Ultimate Guitar" format, but they can also process
 	/// ChordPro format.
 	/// </remarks>
 	public static Func<LineContext, Entry?>[] DefaultLineParsers { get; } =