Docstring fix for function call signatures

Remove duplicated docstring in the function call signature
svilupp · Nov 19, 2023 · 95a5282 · 95a5282
2 parents 8a7a578 + c545cbf
commit 95a5282
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/src/extraction.jl b/src/extraction.jl
@@ -162,6 +162,11 @@ function function_call_signature(datastructtype::Type; max_description_length::I
     ## docstrings
     docs = extract_docstring(datastructtype; max_description_length)
     !isempty(docs) && (schema["description"] = docs)
+    ## remove duplicated Struct docstring in schema
+    if haskey(schema["parameters"], "description") &&
+       schema["parameters"]["description"] == docs
+        delete!(schema["parameters"], "description")
+    end
     return schema
 end
 

diff --git a/test/extraction.jl b/test/extraction.jl
@@ -210,8 +210,7 @@ end
                 "weight" => Dict{String, Any}("type" => "number"),
                 "age" => Dict{String, Any}("type" => "integer")),
             "required" => ["age"],
-            "type" => "object",
-            "description" => "Some docstring\n"),
+            "type" => "object"),
         "description" => "Some docstring\n")
     @test output == expected_output