Skip to content

Improve error message when custom versification does not match detected versification #988

@Enkidu93

Description

@Enkidu93

When running check_versification() in extract_corpora on a project with a custom versification, the error message can be misleading. In a recent example reported by Michael, it logged:

WARNING - Project versification setting 0 does not match detected versification(s) 4. The detected versification(s) were based on Daniel 3:30, Acts 19:41 being the last verse of their respective chapters.

even though the base versification of the project was versification 1. This is because custom versifications always have a type 0 (Unknown).

We should:

  1. Consider whether this error message even makes sense with custom versifications - i.e., since it is custom, it wouldn't be unreasonable that it looks like the wrong versification.
  2. If we do keep this for custom versifications, we should list the versification.base_versification.type in the error message rather than the versification.type for custom versifications. In this example, that would mean logging 1 rather than 0 in the error message.
  3. We should use the versification name rather than the versification type (or perhaps in addition to it). This is generally more interpretable and also would be more helpful for describing custom versifications. For example, versification.name for a custom versification yields the <base-versification-name>-<project-guid> - something like English-1234567890abcdef. If we do this, we may not need to do item 2.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    Status

    🔖 Ready

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions