docs: upgrade dependencies and left align the table (#95)

JuliaImages · May 29, 2021 · 897d4e8 · 897d4e8
1 parent 100e6ae
commit 897d4e8
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 11 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -2,9 +2,11 @@
 CoordinateTransformations = "150eb455-5306-5404-9cee-2592286d6298"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 ImageDraw = "4381153b-2b60-58ae-a1ba-fd683676385f"
+ImageFeatures = "92ff4b2b-8094-53d3-b29d-97f740f06cef"
 ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1"
 Images = "916415d5-f1e6-5110-898d-aaa5f9f070e0"
+Rotations = "6038ab10-8711-5258-84ad-4b1120ba62dc"
 TestImages = "5e47fb64-e119-507b-a336-dd2b206d9990"
 
 [compat]
-Documenter = "0.24"
+Documenter = "0.26"
diff --git a/docs/src/tutorials/brief.md b/docs/src/tutorials/brief.md
@@ -24,10 +24,10 @@ Now, let us create the two images we will match using BRIEF.
 ```@example 1
 using ImageFeatures, TestImages, Images, ImageDraw, CoordinateTransformations
 
-img = testimage("lena_gray_512");
-img1 = Gray.(img);
+img = testimage("lighthouse")
+img1 = Gray.(img)
 trans = Translation(-100, -200)
-img2 = warp(img1, trans, axes(img1));
+img2 = warp(img1, trans, axes(img1))
 nothing # hide
 ```
 
@@ -49,8 +49,8 @@ nothing # hide
 Now pass the image with the keypoints and the parameters to the [`create_descriptor`](@ref) function.
 
 ```@example 1
-desc_1, ret_keypoints_1 = create_descriptor(img1, keypoints_1, brief_params);
-desc_2, ret_keypoints_2 = create_descriptor(img2, keypoints_2, brief_params);
+desc_1, ret_keypoints_1 = create_descriptor(img1, keypoints_1, brief_params)
+desc_2, ret_keypoints_2 = create_descriptor(img2, keypoints_2, brief_params)
 nothing # hide
 ```
 
@@ -64,7 +64,6 @@ nothing # hide
 We can use the [ImageDraw.jl](https://github.com/JuliaImages/ImageDraw.jl) package to view the results.
 
 ```@example 1
-
 grid = hcat(img1, img2)
 offset = CartesianIndex(0, size(img1, 2))
 map(m -> draw!(grid, LineSegment(m[1], m[2] + offset)), matches)

diff --git a/src/brief.jl b/src/brief.jl
@@ -4,7 +4,7 @@ brief_params = BRIEF([size = 128], [window = 9], [sigma = 2 ^ 0.5], [sampling_ty
 ```
 
 | Argument | Type | Description |
-|----------|------|-------------|
+| :------- | :--- | :---------- |
 | **size** | Int | Size of the descriptor |
 | **window** | Int | Size of sampling window |
 | **sigma** | Float64 | Value of sigma used for inital gaussian smoothing of image |

diff --git a/src/brisk.jl b/src/brisk.jl
@@ -4,7 +4,7 @@ brisk_params = BRISK([pattern_scale = 1.0])
 ```
 
 | Argument | Type | Description |
-|----------|------|-------------|
+| :--------| :--- | :---------- |
 | `pattern_scale` | `Float64` | Scaling factor for the sampling window |
 """
 mutable struct BRISK <: Params

diff --git a/src/freak.jl b/src/freak.jl
@@ -4,7 +4,7 @@ freak_params = FREAK([pattern_scale = 22.0])
 ```
 
 | Argument | Type | Description |
-|----------|------|-------------|
+| :--------| :--- | :---------- |
 | **pattern_scale** | Float64 | Scaling factor for the sampling window |
 """
 mutable struct FREAK <: Params

diff --git a/src/orb.jl b/src/orb.jl
@@ -4,7 +4,7 @@ orb_params = ORB([num_keypoints = 500], [n_fast = 12], [threshold = 0.25], [harr
 ```
 
 | Argument | Type | Description |
-|----------|------|-------------|
+| :--------| :--- | :---------- |
 | **num_keypoints** | Int | Number of keypoints to extract and size of the descriptor calculated |
 | **n_fast** | Int | Number of consecutive pixels used for finding corners with FAST. See [`fastcorners`] |
 | **threshold** | Float64 | Threshold used to find corners in FAST. See [`fastcorners`] |