Improve error reporting for USFM versification issues to open file with Ctrl+Click
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 39
- Forks
- 7
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 5
Description
Here's an example of the versification errors shown in the versification_errors.txt created by the onboard project code:
USFM versification error in project , expected verse “EXO 7:25”, actual verse “EXO 7:24”, mismatch type MISSING_VERSE.
It would be very helpful to include the filename and linenumber so that the location of the error can be opened in VSCode with a Ctrl+Click.
/root/M/Paratext/projects//02EXO:
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the onboard project code that creates versification_errors.txt and trace where each USFM versification error is formatted. Run that code with a reproducible versification mismatch, then verify the output includes the filename and line number in a VSCode Ctrl+Click-compatible path format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, vscode
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100