Test doc 5

JuliaPerf · Sep 3, 2024 · e95aded · e95aded
1 parent 67c18da
commit e95aded
Show file tree

Hide file tree

Showing 6 changed files with 2 additions and 199 deletions.
diff --git a/docs/src/api.MD b/docs/src/api.MD
@@ -11,18 +11,6 @@ julia>?
 help?> PerfTest
 ```
 
-## [`metrics`](@ref) type and basic constructors
-```@docs
-metrics
-```
-
-
-## [`regression`](@ref), [`suppress_output`](@ref), [`save_folder`](@ref)
-```@docs
-regression
-suppress_output
-save_folder
-```
 
 
 ## Types

diff --git a/src/PerfTest.jl b/src/PerfTest.jl
@@ -24,7 +24,6 @@ include("metrics.jl")
 include("methodologies/regression.jl")
 include("methodologies/effective_memory_throughput.jl")
 include("methodologies/roofline.jl")
-#include("methodologies/fullroofline.jl")
 
 include("prefix.jl")
 include("suffix.jl")

diff --git a/src/config.jl b/src/config.jl
@@ -85,7 +85,6 @@ verbose = false
 
 max_saved_results = 10
 
-""" MPI, CUDA, ROC options """
 # Will be set to true if the MPI is detected, but it can be triggered manually if needed
 mpi_enabled = false
 
@@ -98,10 +97,8 @@ mpi_enabled = false
 mpi_test_mode = :single
 
 
-""" Tested expressions output handling """
 suppress_output = true
 
-""" Regression testing configuration """
 regression = Struct_Regression(
     enabled = true,
 

diff --git a/src/methodologies/fullroofline.jl b/src/methodologies/fullroofline.jl
diff --git a/src/perftest/data_handling.jl b/src/perftest/data_handling.jl
@@ -30,7 +30,6 @@ function by_index(dict::Union{Dict,BenchmarkGroup}, idx::Vector{DepthRecord})
     return eval(e)
 end
 
-
 """
 This method will return a flattened array of all of the results for all the methodologies exercised in the provided dictionary.
 

diff --git a/src/perftest/structs.jl b/src/perftest/structs.jl
@@ -44,9 +44,8 @@ This struct is used in the test suite to save a metric test result and its assoc
     full_print::Bool
 end
 
-"""
-  A custom methodology element is used to save informational metrics, other special values and custom functions to be executed after testing.
-"""
+
+# A custom methodology element is used to save informational metrics, other special values and custom functions to be executed after testing.
 Custom_Methodology_Elements = Union{Metric_Result,Float64,Function}