Updating doc (#61)

* Bump version 

Co-authored-by: Dominique <[email protected]>

README.md

@@ -179,4 +179,6 @@ julia> delete_all_ba_artifacts!()
 [ Info: The artifact venice/problem-1778-993923-pre.txt.bz2 was not found
 ```
 
+Special thanks to Célestine Angla for her initial work on this project during her internship.
+
 Licensed under the MPL-2.0 [License](LICENSE.md) 

src/BundleAdjustmentArtifactFunctions.jl

@@ -7,7 +7,7 @@ const ba_probs_jld2 = joinpath(@__DIR__, "..", "src", "ba_probs_df.jld2")
 """
     problems_df()
     
-Return a dataframe of the problems and their characteristics
+Return a dataframe of the problems and their characteristics.
 """
 function problems_df()
   file = jldopen(ba_probs_jld2, "r")
@@ -18,6 +18,7 @@ end
 
 """
     get_filename(name::AbstractString)
+
 Analyze the `name` given to check if it matches one of the known names.
 Return the full name with "-pre.txt.bz2" extension.
 """
@@ -39,6 +40,7 @@ end
 
 """
     get_group(name::AbstractString)
+
 Get the group corresponding to the given `name` of the problem.
 """
 function get_group(name::AbstractString)
@@ -74,7 +76,7 @@ end
 
 Get all the problems with the group name `group`.
 Return an array of the paths where the problems are stored.
-Group possibilities are : trafalgar, venice, dubrovnik and ladybug
+Group possibilities are : "trafalgar", "venice", "dubrovnik" and "ladybug".
 """
 function fetch_ba_group(group::AbstractString)
   problem_paths = String[]
@@ -275,7 +277,7 @@ end
 """
     delete_ba_artifact!(name::AbstractString)
 
-Delete the artifact `name` from the artifact store
+Delete the artifact `name` from the artifact store.
 """
 function delete_ba_artifact!(name::AbstractString)
   filename = get_filename(name)
@@ -303,7 +305,7 @@ end
 """
     delete_all_ba_artifacts!()
 
-Delete all the BundleAdjustmentModels artifacts from the artifact store
+Delete all the `BundleAdjustmentModel` artifacts from the artifact store.
 """
 function delete_all_ba_artifacts!()
   for probs_symbol ∈ ba_groups

src/BundleAdjustmentNLSFunctions.jl

@@ -7,7 +7,7 @@ import NLPModels: increment!
 """
 Represent a bundle adjustement problem in the form
 
-    minimize    ||F(x)||²
+    minimize   ½ ‖F(x)‖²
 
 where `F(x)` is the vector of residuals.
 """

src/ReadFiles.jl

@@ -5,7 +5,7 @@
 
 Read the .txt.bzip2 file in Data/filename and extract the data,
 returns the matrices observed 2D points, cameras and points
-and the vectors of camera indices and points indices
+and the vectors of camera indices and points indices.
 """
 function readfile(filename::String; T::Type = Float64)
   f = Bzip2DecompressorStream(open(filename))