From a0addd4751b76902e05d3a2d90eec84f219665bf Mon Sep 17 00:00:00 2001 From: Joe Wesch Date: Tue, 23 Sep 2025 12:04:54 -0500 Subject: [PATCH] Fixes documentation section headers --- changes/+dne.documentation | 1 + docs/user/architecture.md | 2 +- docs/user/lib_getting_started.md | 2 +- docs/user/usage.md | 6 +++--- 4 files changed, 6 insertions(+), 5 deletions(-) create mode 100644 changes/+dne.documentation diff --git a/changes/+dne.documentation b/changes/+dne.documentation new file mode 100644 index 0000000..a18431b --- /dev/null +++ b/changes/+dne.documentation @@ -0,0 +1 @@ +Fixed the section headers for portions of the documentation. \ No newline at end of file diff --git a/docs/user/architecture.md b/docs/user/architecture.md index b5accb3..376f053 100644 --- a/docs/user/architecture.md +++ b/docs/user/architecture.md @@ -57,7 +57,7 @@ Generally, for all of the `CheckTypes`, the arguments will be in the order `inte For regex or parameter matching, your provided regex or dictionary would be the first argument and the collected data would be the second argument. -# Customized JMESPath +## Customized JMESPath 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. diff --git a/docs/user/lib_getting_started.md b/docs/user/lib_getting_started.md index 99e45d6..6a83858 100644 --- a/docs/user/lib_getting_started.md +++ b/docs/user/lib_getting_started.md @@ -1,4 +1,4 @@ -## Getting Started +# Getting Started First, you import the `CheckType` class. diff --git a/docs/user/usage.md b/docs/user/usage.md index 7ebdfd3..4be43b8 100644 --- a/docs/user/usage.md +++ b/docs/user/usage.md @@ -22,7 +22,7 @@ In summary, the workflow is generally: 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. -## `extract_data_from_json` +### `extract_data_from_json` 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. @@ -67,9 +67,9 @@ After getting the response data from an external system, we'll create a query (s This type of logic to extract keys and value from the object is called anchor logic. -# `CheckTypes` Explained +## `CheckTypes` Explained -## exact_match +### Exact Match 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.