search

sinaatalay / rendercv

The engine of the RenderCV App
http://docs.rendercv.com
MIT License
1.75k stars 116 forks source link

Unrecognised keys should throw errors/warnings #139

Open samvanstroud opened 1 month ago

samvanstroud commented 1 month ago

Currently, if a user adds an incorrect key, it is ignored. This can be confusing if a user misspells a valid key, or perhaps imagines a field is supported when it isn't.

If a user provides an invalid key, a warning or error should be raised

sinaatalay commented 1 month ago

This feature has been added in v1.12. Previously, the use of arbitrary keys resulted in errors. It allows users to use their own keys in their custom templates, as described here. However, I am open to discussing whether this feature is a good idea or not.

samvanstroud commented 1 month ago

I would consider adding a allow_custom_keys option to configure this behaviour, it might save some confusion :)

sinaatalay commented 1 month ago

That sounds like a good idea. Maybe we need rendercv_settings in addition to cv, design, and locale_catalog. I will keep this issue open until we decide on an approach. Perhaps someone else could offer a new perspective as well.