OpenJobDescription / openjd-model-for-python

Provides a Python implementation of the data model for Open Job Description's template schemas.
https://github.com/OpenJobDescription/openjd-specifications/wiki
Apache License 2.0
12 stars 7 forks source link

fix: format string errors no longer embed the entire format string #135

Closed ddneilson closed 4 weeks ago

ddneilson commented 4 weeks ago

What was the problem/requirement? (What/Why)

Format strings can be very large (e.g. when they are the 'data' element of an embedded file). The FormatStringError that we report currently embeds the entire format string into the error message. That's unnecessary since our validation errors are already pointing the user directly at the template element that is producing the error.

What was the solution? (How)

This removes the format string data from the error message.

What is the impact of this change?

Easier to read/understand format string error messages.

How was this change tested?

Just running the unit tests.

Was this change documented?

N/A

Is this a breaking change?

No, the contents of an error string is not a contract.


By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

sonarcloud[bot] commented 4 weeks ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud