Skip to content

Commit a0addd4

Browse files
committed
Fixes documentation section headers
1 parent 93a06ba commit a0addd4

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

changes/+dne.documentation

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fixed the section headers for portions of the documentation.

docs/user/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Generally, for all of the `CheckTypes`, the arguments will be in the order `inte
5757

5858
For regex or parameter matching, your provided regex or dictionary would be the first argument and the collected data would be the second argument.
5959

60-
# Customized JMESPath
60+
## Customized JMESPath
6161

6262
Since `jdiff` works with JSON objects as data inputs, JMESPath was the obvious choice for traversing the data and extracting the value(s) to compare. However, JMESPath has a limitation where context is lost for the values it collects, in other words, for each given value that JMESPath returns, we cannot be sure what key it was part of.
6363

docs/user/lib_getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Getting Started
1+
# Getting Started
22

33

44
First, you import the `CheckType` class.

docs/user/usage.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ In summary, the workflow is generally:
2222

2323
Before we get started with the CheckTypes, we've also included a method of extracting portions of the data for comparison. In many cases in data comparison, we aren't interested in the whole piece of data. We've provided this utility to extract subsets of a larger data object.
2424

25-
## `extract_data_from_json`
25+
### `extract_data_from_json`
2626

2727
As an example, in this case of the object below, we are only interested in comparing the value of a single key-value pair from each item in the interfaces dictionary contained within the response.
2828

@@ -67,9 +67,9 @@ After getting the response data from an external system, we'll create a query (s
6767
This type of logic to extract keys and value from the object is called anchor logic.
6868

6969

70-
# `CheckTypes` Explained
70+
## `CheckTypes` Explained
7171

72-
## exact_match
72+
### Exact Match
7373

7474
Check type `exact_match` is concerned with the value of the elements within the data structure. The key-value pairs should match between the reference and comparison data. A diff is generated between the two data sets and tested to see whether all the keys and values match.
7575

0 commit comments

Comments
 (0)