Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rule about kitchen sink info block encapsulation #8

Merged
merged 2 commits into from
Jun 14, 2016
Merged

rule about kitchen sink info block encapsulation #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8429819
added a rule to include delimeters around kitchensink info
Jun 14, 2016
fb81d84
somewhat clearer formulation of the delimiter rules
Jun 14, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/UI/JF_PROPOSAL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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
Expand Down