Description
Description
The formatting of template variables in the "Template Customization" section of the F' backend is incorrect. They are being rendered as plain text, when they should use backticks to be formatted as code.
Type
- Bug: Incorrect formatting in documentation.
Additional context
None.
Requester
- Ivan Perez.
Method to check presence of bug
The following regexp search lists all occurrences of template variables and their immediately surrounding characters, filtering out the ones that have backticks:
$ grep -nHe '.{\+[a-zA-Z]\+}\+.' ogma-cli/README.md | grep -ve '`{\+.*}\+`'
ogma-cli/README.md:491:- {{{ifaceTypePorts}}}: Contain the type declarations for the types used by the
ogma-cli/README.md:494:- {{{ifaceInputPorts}}}: Contains the declarations of the `async input` port,
ogma-cli/README.md:497:- {{{ifaceViolationEvents}}}: Contains the output port declarations, used to
ogma-cli/README.md:502:- {{{hdrHandlers}}}: Contains the declarations of operations to execute when
ogma-cli/README.md:508:- {{{implInputs}}}: Contains the declarations of the variables with inputs
ogma-cli/README.md:511:- {{{implMonitorResults}}}: Contains the declarations of boolean variables,
ogma-cli/README.md:514:- {{{implInputHandlers}}}: Contains the implementations of operations to
ogma-cli/README.md:518:- {{{implTriggerResultReset}}}: Contains instructions that reset the status of
ogma-cli/README.md:521:- {{{implTriggerChecks}}}: Contains instructions that check whether any monitor
ogma-cli/README.md:525:- {{{implTriggers}}}: Contains the implementations of the functions that set
Expected result
The search above is empty, indicating that all template variables in the documentation are surrounded by backticks.
Desired result
The search above is empty, indicating that all template variables in the documentation are surrounded by backticks.
Proposed solution
Modify README to surround all template variables with backticks.
Further notes
None.