Documentation of foreign package configuration options

[GHNewbiee]

When you use foreign packages and want to mention their configuration options, you could also use an extra table to make clearer what options are actually available to the user. A reader/user instantly gets a very good and complete idea. An example/template is given right below:

<package> options

Last updated: xx xxx xx

Option	default	Reboost (1)	User (2)	Remark (3)
...	...	...	YES	About option...; See link (to documentation); etc
		INACTIVATED	Avoid	Causes side effect(s); Under investigation; Not yet investigated; Unknown behaviour; etc
		REMOVED	Never	Breaks Reboost functionality; Fatal error; etc
			May	It's uninteresting; etc

(1) The value (same as default or altered) that Reboost has chosen. Reboost may also decide for some reason to inactivate or remove an option. Columns Reboost and User are not related to each other in the above example.

(2) If user is allowed to alter the value set by Reboost.

(3) Columns User and Remark are fully related to each other in the above example.