From 4ac8fda3167e6ed9616534266e9db15a2dc71acd Mon Sep 17 00:00:00 2001
From: Henry Schreiner <henryschreineriii@gmail.com>
Date: Tue, 1 Aug 2023 10:37:18 -0400
Subject: [PATCH] fix: address review comments

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
---
 docs/serialization.md            | 14 +++++++-------
 src/uhi/resources/histogram.json | 12 ++++++------
 2 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/docs/serialization.md b/docs/serialization.md
index 40511de..cd2bddf 100644
--- a/docs/serialization.md
+++ b/docs/serialization.md
@@ -21,7 +21,7 @@ The following formats are being targeted:
 Other formats can be used as well, assuming they support out-of-band data and
 text attributes or files for the metadata.
 
-## Drawbacks
+## Caveats
 
 This structure was based heavily on boost-histogram, but it is intended to be
 general, and can be expanded in the future as needed. As such, the following
@@ -32,8 +32,8 @@ limitations are required:
   lost, etc.
 * Metadata must be expressible as JSON. It should also be reasonably sized; some
   formats like HDF5 may limit the size of attributes to 64K.
-* Floating point variations could be introduced in storages, as the storage
-  format uses a stable but different representation.
+* Floating point errors could be incurred on conversion, as the storage format
+  uses a stable but different representation.
 * Axis `name` is only part of the metadata, and is not standardized. This is
   due to lack of support from boost-histogram.
 
@@ -49,15 +49,15 @@ The following axes types are supported:
   is either an in-line list of numbers or a string pointing to an out-of-band data source.
   Also has `underflow`, `overflow`, and `circular` properties. `circular`
   defaults to False if not present.
-* `"int_category"`: A list of integer bins, non-continuous. Has `categories`,
+* `"category_int"`: A list of integer bins, non-continuous. Has `categories`,
   which is an in-line list of integers. Also has `flow`.
-* `"str_category"`: A list of string bins. Has `categories`,
+* `"category_str"`: A list of string bins. Has `categories`,
   which is an in-line list of strings. Also has `flow`.
-* `"bool"`: A true/false axis.
+* `"boolean"`: A true/false axis.
 
 Axes with gaps are currently not supported.
 
-All axes support `metadata`.
+All axes support `metadata`, a string-valued dictionary of arbitrary, JSON-like data.
 
 The following storages are supported:
 
diff --git a/src/uhi/resources/histogram.json b/src/uhi/resources/histogram.json
index 6dab3ba..e62ecbb 100644
--- a/src/uhi/resources/histogram.json
+++ b/src/uhi/resources/histogram.json
@@ -21,8 +21,8 @@
             "oneOf": [
               { "$ref": "#/$defs/regular_axis" },
               { "$ref": "#/$defs/variable_axis" },
-              { "$ref": "#/$defs/str_category_axis" },
-              { "$ref": "#/$defs/int_category_axis" },
+              { "$ref": "#/$defs/category_str_axis" },
+              { "$ref": "#/$defs/category_int_axis" },
               { "$ref": "#/$defs/boolean_axis" }
             ]
           }
@@ -101,13 +101,13 @@
         }
       }
     },
-    "str_category_axis": {
+    "category_str_axis": {
       "type": "object",
       "description": "A set of string categorical bins.",
       "required": ["type", "categories", "flow"],
       "additionalProperties": false,
       "properties": {
-        "type": { "type": "string", "const": "str_category" },
+        "type": { "type": "string", "const": "category_str" },
         "categories": {
           "type": "array",
           "items": { "type": "string" },
@@ -123,13 +123,13 @@
         }
       }
     },
-    "int_category_axis": {
+    "category_int_axis": {
       "type": "object",
       "description": "A set of integer categorical bins in any order.",
       "required": ["type", "categories", "flow"],
       "additionalProperties": false,
       "properties": {
-        "type": { "type": "string", "const": "int_category" },
+        "type": { "type": "string", "const": "category_int" },
         "categories": {
           "type": "array",
           "items": { "type": "integer" },