Skip to content

Fix verses appearing in remarks when missing a paragraph marker #462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Enkidu93 merged 1 commit into from
Jul 24, 2026
Merged

Fix verses appearing in remarks when missing a paragraph marker #462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/SIL.Machine/Corpora/UpdateUsfmParserHandler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,10 @@ public string GetUsfm(UsfmStylesheet stylesheet)
index++;
}

// If the next token is a verse, add \nb to prevent the verse appearing in the remark
if (tokens[index].Type == UsfmTokenType.Verse)
tokens.Insert(index, new UsfmToken(UsfmTokenType.Paragraph, "nb", null, null));

tokens.InsertRange(index, remarkTokens.Value);
}
}
Expand Down
59 changes: 59 additions & 0 deletions tests/SIL.Machine.Tests/Corpora/UpdateUsfmParserHandlerTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1366,6 +1366,61 @@ public void GetUsfm_PassRemark()
\ide UTF-8
\rem Existing remark
\c 1
\p
\v 1 Some text
\v 2
\v 3 Other text
\c 2
\rem Existing remark
\p
\v 1 More text
\c 3
";

string target = UpdateUsfm(
rows,
usfm,
textBehavior: UpdateUsfmTextBehavior.PreferExisting,
remarks: [(0, "New remark 0"), (1, "New remark 1"), (2, "New remark 2"), (3, "New remark 3")]
);

string result =
@"\id MAT - Test
\ide UTF-8
\rem Existing remark
\rem New remark 0
\c 1
\rem New remark 1
\p
\v 1 Some text
\v 2 Update 2
\v 3 Other text
\c 2
\rem Existing remark
\rem New remark 2
\p
\v 1 More text
\c 3
\rem New remark 3
";

AssertUsfmEquals(target, result);
}

[Test]
public void GetUsfm_PassRemark_NoBodyParagraph()
{
List<UpdateUsfmRow> rows =
[
new UpdateUsfmRow(ScrRef("MAT 1:1"), "Update 1"),
new UpdateUsfmRow(ScrRef("MAT 1:2"), "Update 2"),
];

string usfm =
@"\id MAT - Test
\ide UTF-8
\rem Existing remark
\c 1
\v 1 Some text
\v 2
\v 3 Other text
Expand All @@ -1389,12 +1444,14 @@ public void GetUsfm_PassRemark()
\rem New remark 0
\c 1
\rem New remark 1
\nb
\v 1 Some text
\v 2 Update 2
\v 3 Other text
\c 2
\rem Existing remark
\rem New remark 2
\nb
\v 1 More text
\c 3
\rem New remark 3
Expand Down Expand Up @@ -1455,6 +1512,7 @@ public void GetUsfm_MultipleRemarksSameChapter()
\ide UTF-8
\rem Existing remark
\c 1
\q1
\v 1 Some text
\v 2
\v 3 Other text
Expand All @@ -1476,6 +1534,7 @@ public void GetUsfm_MultipleRemarksSameChapter()
\c 1
\rem New remark 1.1
\rem New remark 1.2
\q1
\v 1 Some text
\v 2 Update 2
\v 3 Other text
Expand Down
Loading