james-fray / tab-reloader

Multiple-browser tab reloader extension
https://webextension.org/listing/tab-reloader.html
112 stars 31 forks source link

Improvement of the documentation for json usage description #123

Closed rloutrel closed 11 months ago

rloutrel commented 2 years ago

Your documentation is incredibly good: It is a pleasure to use your extension (also) for this reason.

In the description https://add0n.com/tab-reloader.html#faq27 , I noticed 3 points which could be improved to avoid misunderstanding: 1/ list mandatory (I assume all time keys) vs optional keys 2/ For the optional keys, the default value could be specified (eg. the cache, I would assume, that default value is true, since the reload button of firefox is F5, but using the UI-Way to add a reloader is using false as default). Knowing what is the default would have pleased me (I can test, of course, but I suppose it could also be in the documentation) 3/ the json examples: I am used to use json for my work, but others might not. The boolean example might be confusing for people without json knowledge and result in key: true or "key": "true". Therefore, your example should be "key_with_quote_chars": true to explicitly distinguish the string format from a boolean format.

Feel free to close this ticket without asking, I will not argue since it works for me