fix markdownlint warnings

llaville · Dec 20, 2021 · 70aa23a · 70aa23a
1 parent fcac994
commit 70aa23a
Show file tree

Hide file tree

Showing 50 changed files with 51 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # Changelog
 
 All notable changes to this project will be documented in this file.

diff --git a/README.md b/README.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # SARIF PHP SDK
 
 | Stable |
@@ -30,4 +31,5 @@ generated from the [docs](https://github.com/llaville/sarif-php-sdk/tree/master/
 - API [Reference](docs/reference/) describes all SARIF objects with examples.
 
 And also
+
 - [Study the tutorials](https://github.com/microsoft/sarif-tutorials) from GitHub's Microsoft account.
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # About
 
 This PHP SDK produces the SARIF output, which is a JSON file formatted

diff --git a/docs/reference/address.md b/docs/reference/address.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # address object
 
 An `address` object describes a physical or virtual address,

diff --git a/docs/reference/artifact.md b/docs/reference/artifact.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # artifact object
 
 An `artifact` object represents a single artifact.

diff --git a/docs/reference/artifactChange.md b/docs/reference/artifactChange.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # artifactChange object
 
 An `artifactChange` object represents a change to a single artifact.

diff --git a/docs/reference/artifactContent.md b/docs/reference/artifactContent.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # artifactContent object
 
 Certain properties in this document represent the contents of portions of artifacts external to the log file,

diff --git a/docs/reference/attachment.md b/docs/reference/attachment.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # attachment object
 
 An `attachment` object describes an artifact relevant to the detection of a result.

diff --git a/docs/reference/codeFlow.md b/docs/reference/codeFlow.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # codeFlow object
 
 A `codeFlow` object describes the progress of one or more programs through one or more thread flows,

diff --git a/docs/reference/configurationOverride.md b/docs/reference/configurationOverride.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # configurationOverride object
 
 A `configurationOverride` object modifies the effective runtime configuration of a specified `reportingDescriptor` object,

diff --git a/docs/reference/conversion.md b/docs/reference/conversion.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # conversion object
 
 A `conversion` object describes how a converter transformed the output of an analysis tool

diff --git a/docs/reference/edge.md b/docs/reference/edge.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # edge object
 
 A `edge` object represents a directed edge in the graph represented by theGraph.

diff --git a/docs/reference/edgeTraversal.md b/docs/reference/edgeTraversal.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # edgeTraversal object
 
 An `edgeTraversal` object represents the traversal of a single edge during a graph traversal.

diff --git a/docs/reference/exception.md b/docs/reference/exception.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # exception object
 
 An `exception` object describes a runtime exception encountered during the execution of an analysis tool.

diff --git a/docs/reference/externalProperties.md b/docs/reference/externalProperties.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # externalProperties object
 
 The top-level element of an external property file SHALL be an object which we refer to as an `externalProperties` object.

diff --git a/docs/reference/externalPropertyFileReference.md b/docs/reference/externalPropertyFileReference.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # externalPropertyFileReference object
 
 An `externalPropertyFileReference` object contains information that enables a SARIF consumer

diff --git a/docs/reference/externalPropertyFileReferences.md b/docs/reference/externalPropertyFileReferences.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # externalPropertyFileReferences object
 
 An `externalPropertyFileReferences` object contains information that enables a SARIF consumer

diff --git a/docs/reference/fix.md b/docs/reference/fix.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # fix object
 
 A `fix` object represents a proposed fix for the problem indicated by theResult. It specifies a set of artifacts to modify.

diff --git a/docs/reference/graph.md b/docs/reference/graph.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # graph object
 
 A `graph` object represents a directed graph, a network of nodes and directed edges

diff --git a/docs/reference/graphTraversal.md b/docs/reference/graphTraversal.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # graphTraversal object
 
 A `graphTraversal` object represents a "graph traversal", that is, a path through

diff --git a/docs/reference/invocation.md b/docs/reference/invocation.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # invocation object
 
 An `invocation` object describes the invocation of the analysis tool that was run.

diff --git a/docs/reference/locationRelationship.md b/docs/reference/locationRelationship.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # locationRelationship object
 
 A `locationRelationship` object specifies one or more directed relationships from one location object,

diff --git a/docs/reference/logicalLocation.md b/docs/reference/logicalLocation.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # logicalLocation object
 
 A `logicalLocation` object describes a logical location.

diff --git a/docs/reference/message.md b/docs/reference/message.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # message object
 
 Certain objects in this document define messages intended to be viewed by a user.

diff --git a/docs/reference/node.md b/docs/reference/node.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # node object
 
 A `node` object represents a node in the graph represented by the containing graph object, which we refer to as theGraph.

diff --git a/docs/reference/notification.md b/docs/reference/notification.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # notification object
 
 A `notification` object describes a condition encountered during the execution of an analysis tool

diff --git a/docs/reference/physicalLocation.md b/docs/reference/physicalLocation.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # physicalLocation object
 
 A `physicalLocation` object represents the physical location where a result was detected.

diff --git a/docs/reference/rectangle.md b/docs/reference/rectangle.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # rectangle object
 
 A `rectangle` object specifies a rectangular area within an image.

diff --git a/docs/reference/replacement.md b/docs/reference/replacement.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # replacement object
 
 A `replacement` object represents the replacement of a single region of an artifact.

diff --git a/docs/reference/reportingConfiguration.md b/docs/reference/reportingConfiguration.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # reportingConfiguration object
 
 A `reportingConfiguration` object contains the information in a `reportingDescriptor` that a SARIF producer can modify

diff --git a/docs/reference/reportingDescriptor.md b/docs/reference/reportingDescriptor.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # reportingDescriptor object
 
 A `reportingDescriptor` object contains information that describes a "reporting item" generated by a tool.

diff --git a/docs/reference/reportingDescriptorReference.md b/docs/reference/reportingDescriptorReference.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # reportingDescriptorReference object
 
 A `reportingDescriptorReference` object identifies a particular `reportingDescriptor` object,

diff --git a/docs/reference/reportingDescriptorRelationship.md b/docs/reference/reportingDescriptorRelationship.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # reportingDescriptorRelationship object
 
 A `reportingDescriptorRelationship` object specifies one or more directed relationships

diff --git a/docs/reference/result.md b/docs/reference/result.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # result object
 
 A `result` object describes a single result detected by an analysis tool.

diff --git a/docs/reference/resultProvenance.md b/docs/reference/resultProvenance.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # resultProvenance object
 
 A `resultProvenance` object contains information about the how and when theResult was detected.

diff --git a/docs/reference/run.md b/docs/reference/run.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # run object
 
 An sarifLog object specifies the version of the file format and contains the output from one or more runs.

diff --git a/docs/reference/runAutomationDetails.md b/docs/reference/runAutomationDetails.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # runAutomationDetails object
 
 A `runAutomationDetails` object contains information that specifies theRun’s identity and role within an engineering system.

diff --git a/docs/reference/sarifLog.md b/docs/reference/sarifLog.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # sariflog object
 
 An sarifLog object specifies the version of the file format and contains the output from one or more runs.

diff --git a/docs/reference/specialLocations.md b/docs/reference/specialLocations.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # specialLocations object
 
 A `specialLocations` object defines locations of special significance to SARIF consumers.

diff --git a/docs/reference/stack.md b/docs/reference/stack.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # stack object
 
 A `stack` object describes a single call stack.

diff --git a/docs/reference/stackFrame.md b/docs/reference/stackFrame.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # stackFrame object
 
 A `stackFrame` object describes a single stack frame within a call stack.

diff --git a/docs/reference/suppression.md b/docs/reference/suppression.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # suppression object
 
 A `suppression` object describes a request to suppress a result.

diff --git a/docs/reference/threadFlow.md b/docs/reference/threadFlow.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # threadFlow object
 
 A `threadFlow` object is a sequence of code locations that specify a possible path through a single thread of execution

diff --git a/docs/reference/threadFlowLocation.md b/docs/reference/threadFlowLocation.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # threadFlowLocation object
 
 A `threadFlowLocation` object represents a location visited by an analysis tool

diff --git a/docs/reference/tool.md b/docs/reference/tool.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # tool object
 
 A `tool` object describes the analysis tool or converter that was run.

diff --git a/docs/reference/toolComponentReference.md b/docs/reference/toolComponentReference.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # toolComponentReference object
 
 A `toolComponentReference` object identifies a particular `toolComponent` object,

diff --git a/docs/reference/translationMetadata..md b/docs/reference/translationMetadata..md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # translationMetadata object
 
 A `translationMetadata` object defines locations of special significance to SARIF consumers.

diff --git a/docs/reference/versionControlDetails.md b/docs/reference/versionControlDetails.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # versionControlDetails object
 
 A `versionControlDetails` object specifies the information necessary to retrieve from a version control system (VCS)

diff --git a/docs/reference/webRequest.md b/docs/reference/webRequest.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # webRequest object
 
 A `webRequest` object describes an HTTP request (RFC7230).

diff --git a/docs/reference/webResponse.md b/docs/reference/webResponse.md
@@ -1,3 +1,4 @@
+<!-- markdownlint-disable MD013 -->
 # webResponse object
 
 A `webResponse` object describes the response to an HTTP request (RFC7230)