summaryrefslogtreecommitdiff
path: root/doc/concepts/doc-strings.org
AgeCommit message (Collapse)Author
2023-06-12doc: Convert orgmode files to markdownOliver Reiche
2023-02-28Various typo fixesPaul Cristian Sarbu
Co-authored-by: Sascha Roloff <sascha.roloff@huawei.com>
2023-02-22docs: Fix typos in general documentationPaul Cristian Sarbu
2022-04-26doc strings: support documentation of the resultKlaus Aehlig
A complete documentation of a rule should not only include how to use it (i.e., which fields are present and what is their meaning) but also what the result is. This is particularly true, as the result is structured and can contain some complex logic or conventions in the provided information.
2022-03-22Document the way we use our documentation stringsKlaus Aehlig