This repository has been archived by the owner on Jun 11, 2023. It is now read-only.
Documentation of foreign package configuration options #15
Labels
documentation
Improvements or additions to documentation
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
Reboost
functionality; Fatal error; 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. ColumnsReboost
andUser
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
andRemark
are fully related to each other in the above example.The text was updated successfully, but these errors were encountered: