Apply suggestions from code review

Co-authored-by: Rafael Schouten <[email protected]>
rafaqz · Jun 30, 2024 · 6c95d37 · 6c95d37
1 parent af4d916
commit 6c95d37
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/documentation.jl b/src/documentation.jl
@@ -1,10 +1,10 @@
-function header(interface::Type{<:Interface})
+function _help_header(interface::Type{<:Interface})
     m_keys = mandatory_keys(interface)
     o_keys = optional_keys(interface)
     return "An Interfaces.jl `Interface` with mandatory components `$m_keys` and optional components `$o_keys`."
 end
 
-function extended_help(interface::Type{<:Interface})
+function _extended_help(interface::Type{<:Interface})
     comp = components(interface)
 
     io_buf = IOBuffer()

diff --git a/src/interface.jl b/src/interface.jl
@@ -81,8 +81,8 @@ macro interface(interface::Symbol, type, components, description)
         # Generate a docstring for the interface
         let description=$description,
             interfacesym=$(QuoteNode(interface)),
-            header=$Interfaces.header($interface),
-            extended_help=$Interfaces.extended_help($interface)
+            header=$Interfaces._help_header($interface),
+            extended_help=$Interfaces._extended_help($interface)
             @doc """
                 $("   ") $interfacesym