Opened on 03/06/20 at 15:27:25
Last modified on 06/23/21 at 07:07:55
#3901 closed task
New template for configuration options with a value — at Version 2
Reported by: | Sebastian Huber | Owned by: | Sebastian Huber |
---|---|---|---|
Priority: | normal | Milestone: | 5.1 |
Component: | doc | Version: | 5 |
Severity: | normal | Keywords: | qualification |
Cc: | Blocked By: | ||
Blocking: | #3836 |
Description (last modified by Sebastian Huber)
Change the documentation template for configuration options with a value to:
.. _CONFIGURE_XYZ: CONFIGURE_XYZ ------------- CONSTANT: ``CONFIGURE_XYZ`` OPTION TYPE: This configuration option is an integer define. VALUE CONSTRAINTS: The specified value must be greater than or equal to X and less than or equal to Y. DEFAULT VALUE: The default value is Z. DESCRIPTION: This configuration option defines the ABC. NOTES: Notes for XYZ.
Use OPTION TYPE
instead of DATA TYPE
since we have to characterize the option an not just the value of an option. This is in line with #3900.
Use VALUE RANGE
instead of RANGE
to be more specific.
Change History (2)
comment:1 Changed on 03/06/20 at 15:28:34 by Sebastian Huber
Blocking: | 3836 added |
---|
comment:2 Changed on 03/27/20 at 11:54:18 by Sebastian Huber
Description: | modified (diff) |
---|
Note: See
TracTickets for help on using
tickets.