By now, I've become familiar with the error handling of Lexurgy. What I've noticed, is that there's next to no information about it in the documentation (or on github, for that matter), specifically the cheat sheet. The only place I can find mention of errors is in the sentence "Found a bug? Want to request a feature? Open an issue on GitHub." (here)
I suggest adding a section in the user guide or tutorial describing what errors mean what, and how to report bugs. For example, that any "programming error" with empty reason should be reported as an issue; that user error messages that don't adequately explain what the issue is (or where, for that matter) should also be reported; that you should first check whether the rule you suspect is causing the problems is actually the perpetrator by commenting it out; that you should try to provide a minimal example (to reasonable extent); maybe a section on what information to provide in an issue report; an overview of common error messages with examples and the solutions to those examples.
I think this could help people less familiar with the tool in understanding what exactly is wrong when they encounter an error, while also streamlining the bug report process.
By now, I've become familiar with the error handling of Lexurgy. What I've noticed, is that there's next to no information about it in the documentation (or on github, for that matter), specifically the cheat sheet. The only place I can find mention of errors is in the sentence "Found a bug? Want to request a feature? Open an issue on GitHub." (here)
I suggest adding a section in the user guide or tutorial describing what errors mean what, and how to report bugs. For example, that any "programming error" with empty reason should be reported as an issue; that user error messages that don't adequately explain what the issue is (or where, for that matter) should also be reported; that you should first check whether the rule you suspect is causing the problems is actually the perpetrator by commenting it out; that you should try to provide a minimal example (to reasonable extent); maybe a section on what information to provide in an issue report; an overview of common error messages with examples and the solutions to those examples.
I think this could help people less familiar with the tool in understanding what exactly is wrong when they encounter an error, while also streamlining the bug report process.