Documentation improvements

scheinerman · Aug 30, 2024 · f78cb48 · f78cb48
1 parent d7f492c
commit f78cb48
Show file tree

Hide file tree

Showing 7 changed files with 14 additions and 14 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "Bijections"
 uuid = "e2ed5e7c-b2de-5872-ae92-c73ca462fb04"
-version = "0.1.8"
+version = "0.1.9"
 
 [compat]
 julia = "1"

diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@ A `Bijection` data type for Julia.
 
 
 A `Dict` in Julia is not one-to-one. Two different keys might have the
-same value. This data structure behaves just like a `Dict` except it
-blocks assigning the same value to two different keys.
+same value. A `Bijection` data structure behaves just like a `Dict` except it
+prevents assigning the same value to two different keys.
 
 ## Getting Started
 
@@ -28,7 +28,7 @@ and values are of `Any` type.
 
 * `b = Bijection(pair_list::Vector{Pair{S, T}})`: Create a new `Bijection` using a list of pairs.
 
-## Adding and deleting pairs
+## Adding and Deleting Pairs
 
 Once a `Bijection`, `b`, is created, we add a new key-value pair in
 the same manner as with a `Dict`:
@@ -103,7 +103,7 @@ julia> b("hello")
 ERROR: KeyError: hello not found
 ```
 
-## Creating an inverse `Bijection`
+## Creating an Inverse `Bijection`
 
 There are two functions that take a `Bijection` and return a new
 `Bijection` that is the functional inverse of the original:

diff --git a/docs/build/.documenter-siteinfo.json b/docs/build/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-25T09:25:10","documenter_version":"1.5.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-08-30T07:47:13","documenter_version":"1.5.0"}}
diff --git a/docs/build/index.html b/docs/build/index.html
diff --git a/docs/build/objects.inv b/docs/build/objects.inv
diff --git a/docs/build/search_index.js b/docs/build/search_index.js
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -4,8 +4,8 @@ A `Bijection` data type for Julia.
 
 
 A `Dict` in Julia is not one-to-one. Two different keys might have the
-same value. This data structure behaves just like a `Dict` except it
-blocks assigning the same value to two different keys.
+same value. A `Bijection` data structure behaves just like a `Dict` except it
+prevents assigning the same value to two different keys.
 
 ## Getting Started
 
@@ -28,7 +28,7 @@ and values are of `Any` type.
 
 * `b = Bijection(pair_list::Vector{Pair{S, T}})`: Create a new `Bijection` using a list of pairs.
 
-## Adding and deleting pairs
+## Adding and Deleting Pairs
 
 Once a `Bijection`, `b`, is created, we add a new key-value pair in
 the same manner as with a `Dict`:
@@ -103,7 +103,7 @@ julia> b("hello")
 ERROR: KeyError: hello not found
 ```
 
-## Creating an inverse `Bijection`
+## Creating an Inverse `Bijection`
 
 There are two functions that take a `Bijection` and return a new
 `Bijection` that is the functional inverse of the original:
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-08-25T09:25:10","documenter_version":"1.5.0"}}
		{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-08-30T07:47:13","documenter_version":"1.5.0"}}