jenkins/sap-jenkins-library
1
0
Fork 0
mirror of https://github.com/SAP/jenkins-library.git synced 2025-11-06 09:09:19 +02:00
Code Issues Releases Activity

fix Markdown issues (#365)

Browse Source 
* fix Markdown issue 'Headers should be surrounded by blank lines'

* fix MD012

* fix MD022

* fix MD026

* fix MD007

* fix MD032

* fix MD038

* fix MD040

* fix MD031

* fix MD034

* fix MD004

* fix new findings

* fix MD036

* fix MD038

* fix MD032

* fix MD006
This commit is contained in:
Christopher Fenner
2018-11-06 13:50:09 +01:00
committed by GitHub
parent a405e7e82c
commit f757a0e1d4
37 changed files with 402 additions and 215 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
template/script.md
View File

@@ -1,6 +1,7 @@
# <script name>
## Description
Brief description.
## Constructors
@@ -8,6 +9,7 @@ Brief description.
### <script name>(<arguments>)
#### Parameters
| parameter | mandatory | default | possible values |
| ---------------|-----------|-----------------------------------|--------------------|
| | | | |
@@ -15,36 +17,43 @@ Brief description.
* `<parameter>` - Detailed description of each parameter.
#### Exceptions
* `ExceptionType`
* List of cases when exception is thrown.
* List of cases when exception is thrown.
#### Example
```groovy
```
## Method Details
### <method>(<arguments>)
#### Description
Brief description.
#### Parameters
* `<parameter>` - Detailed description of each parameter.
#### Return value
none
#### Side effects
none
#### Exceptions
* `ExceptionType`
* List of cases when exception is thrown.
* List of cases when exception is thrown.
#### Example
```groovy
```

10
template/step.md
View File

@@ -1,12 +1,15 @@
# <step name>
## Description
Brief description.
## Prerequisites
* **<prerequisite>** - further description.
## Parameters
| parameter | mandatory | default | possible values |
| ---------------|-----------|-----------------------------------|--------------------|
| | | | |
@@ -14,21 +17,26 @@ Brief description.
* `<parameter>` - Detailed description of each parameter.
## Step configuration
The following parameters can also be specified as step parameters using the global configuration file:
* `<parameter>`
## Return value
none
## Side effects
none
## Exceptions
* `ExceptionType`
* List of cases when exception is thrown.
* List of cases when exception is thrown.
## Example
```groovy
```