From 842981938564181d2bb0b8b212e7aa8cf4b2903f Mon Sep 17 00:00:00 2001 From: Denis Kloepfer Date: Tue, 14 Jun 2016 14:43:00 +0200 Subject: [PATCH 1/2] added a rule to include delimeters around kitchensink info --- src/UI/JF_PROPOSAL.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/UI/JF_PROPOSAL.md b/src/UI/JF_PROPOSAL.md index ed3c73e5d7fc..ea6bd5f2bd49 100644 --- a/src/UI/JF_PROPOSAL.md +++ b/src/UI/JF_PROPOSAL.md @@ -101,6 +101,7 @@ The interface to the main factory is \ILIAS\UI\Factory. * MUST separate the block containing Kitchen Sink information from the block containing documentation of parameters by an empty line in the DocBlock. * The block in the documentation containing Kitchen Sink information: + * MUST be enclosed by two lines containing only the delimiter `---`. * SHOULD contain a field `description` that is a dictionary containing one or more than one of the following text fields: * `purpose` - describes the usage scenario of the component From fb81d8488414f0f3d7d12a7caee77653a8f0b66d Mon Sep 17 00:00:00 2001 From: Denis Kloepfer Date: Tue, 14 Jun 2016 14:55:03 +0200 Subject: [PATCH 2/2] somewhat clearer formulation of the delimiter rules --- src/UI/JF_PROPOSAL.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/UI/JF_PROPOSAL.md b/src/UI/JF_PROPOSAL.md index ea6bd5f2bd49..f9546d325108 100644 --- a/src/UI/JF_PROPOSAL.md +++ b/src/UI/JF_PROPOSAL.md @@ -101,7 +101,7 @@ The interface to the main factory is \ILIAS\UI\Factory. * MUST separate the block containing Kitchen Sink information from the block containing documentation of parameters by an empty line in the DocBlock. * The block in the documentation containing Kitchen Sink information: - * MUST be enclosed by two lines containing only the delimiter `---`. + * MUST be enclosed by comment lines containing only the delimiter `---`. * SHOULD contain a field `description` that is a dictionary containing one or more than one of the following text fields: * `purpose` - describes the usage scenario of the component