Improve error logging messages

modelmat / sphinxcontrib-drawio

Sphinx extension for including draw.io files.

MIT License

39 stars 17 forks source link

Improve error logging messages #96

Closed jdillard closed 9 months ago

jdillard commented 9 months ago

Summary of changes

Add the configured arguments ({' '.join(drawio_args)) to the export_abspath.exists() error check
- I had this error thrown due to what ended up being a misconfiguration, but it was too vague making the misconfiguration not so obvious to spot. This also brings this message in line with the other messages that include drawio_args.
Use string format shorthand as I find that syntax more human readable.
- This is a style preference, and I don't mind reverting is desired.

jdillard commented 9 months ago

Not particularly a fan of f-strings with more complex things (e.g. function calls or ' '.join(args) but I don't care enough to really mind, it's still readable.

Same, I thought about that but wasn't sure if I was starting to overthink things. I used named arguments for the messages with " ".join(args), is that better?: https://github.com/modelmat/sphinxcontrib-drawio/pull/96/commits/faac549226d12f2903f2be30aaa272c4f61f82be

modelmat commented 9 months ago

Yeah, LGTM.