Merge pull request #1065 from JuliaRobotics/24Q1/docs/missingdocs

a few missing docstrings

Author: dehann

.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       fail-fast: false
       matrix:
         version:
-          - '~1.10.0-0'
+          - '1.10'
           - 'nightly'
         os:
           - ubuntu-latest
@@ -82,7 +82,7 @@ jobs:
       - name: Setup julia
         uses: julia-actions/setup-julia@v1
         with:
-          version: 1.9
+          version: '1.10'
           arch: x64
 
       - name: Build Docs

Project.toml

@@ -37,28 +37,39 @@ GraphPlot = "a2cc645c-3eea-5389-862e-a155d0052231"
 DFGPlots = "GraphPlot"
 
 [compat]
+Aqua = "0.8"
+Base64 = "1.10"
 CSV = "0.10"
 CodecZlib = "0.7"
 Colors = "0.10, 0.11, 0.12"
+DataStructures = "0.18"
+Dates = "1.10"
 Distributions = "0.23, 0.24, 0.25"
 DocStringExtensions = "0.8, 0.9"
 FileIO = "1"
 GraphPlot = "0.5.0"
 Graphs = "1.4"
+InteractiveUtils = "1.10"
 JSON3 = "1"
+LinearAlgebra = "1.10"
 ManifoldsBase = "0.14, 0.15"
+Manifolds = "0.9"
 OrderedCollections = "1.4"
 Pkg = "1.4, 1.5"
 ProgressMeter = "1"
 RecursiveArrayTools = "2, 3"
 Reexport = "1"
 SHA = "0.7, 1"
+SparseArrays = "1.10"
 StaticArrays = "1"
+Statistics = "1.10"
 StructTypes = "1"
 Tar = "1.9"
+Test = "1.10"
 TensorCast = "0.3.3, 0.4"
 TimeZones = "1.3.1"
-julia = "1.9"
+UUIDs = "1.10"
+julia = "1.10"
 
 [extras]
 Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"

src/Common.jl

@@ -124,5 +124,16 @@ end
 ## Additional Downstream dispatches
 ## =================================
 
+"""
+    $SIGNATURES
+
+Default non-parametric graph solution.
+"""
 function solveGraph! end
+
+"""
+    $SIGNATURES
+
+Standard parametric graph solution (Experimental).
+"""
 function solveGraphParametric! end

src/FileDFG/services/FileDFG.jl

@@ -91,6 +91,8 @@ loadDFG!(dfg, "/tmp/savedgraph.tar.gz")
 # Use the DFG as you do normally.
 ls(dfg)
 ```
+
+See also: [`loadDFG`](@ref), [`saveDFG`](@ref)
 """
 function loadDFG!(
     dfgLoadInto::AbstractDFG,
@@ -218,6 +220,13 @@ function loadDFG!(
     return dfgLoadInto
 end
 
+"""
+    $SIGNATURES
+
+Convenience graph loader into a default `LocalDFG`.
+
+See also: [`loadDFG!`](@ref), [`saveDFG`](@ref)
+"""
 function loadDFG(file::AbstractString)
 
     # add if doesn't have .tar.gz extension
@@ -238,7 +247,7 @@ function loadDFG(file::AbstractString)
     fgPacked = JSON3.read(jstr, GraphsDFGs.PackedGraphsDFG)
     dfg = GraphsDFGs.unpackDFGMetadata(fgPacked)
 
-    @debug "DFG.loadDFG! is deleting a temp folder created during unzip, $loaddir"
+    @debug "DFG.loadDFG is deleting a temp folder created during unzip, $loaddir"
     # cleanup temporary folder
     Base.rm(loaddir; recursive = true, force = true)
 

test/runtests.jl

@@ -148,9 +148,9 @@ end
     Aqua.test_ambiguities([DistributedFactorGraphs])
     Aqua.test_unbound_args(DistributedFactorGraphs)
     Aqua.test_undefined_exports(DistributedFactorGraphs)
-    Aqua.test_piracy(DistributedFactorGraphs)
+    Aqua.test_piracies(DistributedFactorGraphs)
     Aqua.test_project_extras(DistributedFactorGraphs)
     Aqua.test_stale_deps(DistributedFactorGraphs; ignore = [:Colors])
     Aqua.test_deps_compat(DistributedFactorGraphs)
-    Aqua.test_project_toml_formatting(DistributedFactorGraphs)
+    # Aqua.test_project_toml_formatting(DistributedFactorGraphs) # deprecated in Aqua.jl v0.8
 end