move docstrings from ext to main

Author: hexaeder

docs/make.jl

@@ -35,11 +35,10 @@ for example in filter(contains(r".jl$"), readdir(example_dir, join=true))
 end
 
 mtkext = Base.get_extension(NetworkDynamics, :NetworkDynamicsMTKExt)
-dfext = Base.get_extension(NetworkDynamics, :NetworkDynamicsDataFramesExt)
 kwargs = (;
     root=joinpath(pkgdir(NetworkDynamics), "docs"),
     sitename="NetworkDynamics",
-    modules=[NetworkDynamics, mtkext, dfext, NetworkDynamicsInspector],
+    modules=[NetworkDynamics, mtkext, NetworkDynamicsInspector],
     linkcheck=true, # checks if external links resolve
     pagesonly=true,
     plugins=[links],

ext/NetworkDynamicsDataFramesExt.jl

@@ -30,23 +30,6 @@ function _df_from_pair(list, pair)
     df
 end
 
-"""
-    describe_vertices(nw::Network, extras...; parameters=true, states=true, batch=nothing)
-
-Creates a DataFrame containing information about the vertices in a Network.
-
-# Arguments
-- `nw::Network`: The network to describe
-- `extras...`: Additional pairs of (key, function) to include as columns,
-   where the function gets the [`VertexModel`](@ref) as its only parameter
-   to extract a custom metadata field for example..
-- `parameters=true`: Whether to include parameter values
-- `states=true`: Whether to include state values
-- `batch=nothing`: Optionally filter by specific batches
-
-# Returns
-A DataFrame with columns for vertex indices, names, batch numbers, and any parameter/state values.
-"""
 function NetworkDynamics.describe_vertices(nw::Network, extras...; parameters=true, states=true, batch=nothing)
     pairs = enumerate(nw.im.vertexm);
     batches = map(idx -> findfirst(batch -> idx ∈ batch.indices, nw.vertexbatches), first.(pairs))
@@ -78,23 +61,6 @@ function NetworkDynamics.describe_vertices(nw::Network, extras...; parameters=tr
     foldl((a,b) -> DataFrames.leftjoin(a,b; on=:idx), dfs)
 end
 
-"""
-    describe_edges(nw::Network, extras...; parameters=true, states=true, batch=nothing)
-
-Creates a DataFrame containing information about the edges in a Network.
-
-# Arguments
-- `nw::Network`: The network to describe
-- `extras...`: Additional pairs of (key, function) to include as columns,
-   where the function gets the [`EdgeModel`](@ref) as its only parameter
-   to extract a custom metadata field for example..
-- `parameters=true`: Whether to include parameter values
-- `states=true`: Whether to include state values
-- `batch=nothing`: Optionally filter by specific batches
-
-# Returns
-A DataFrame with columns for edge indices, source-destination pairs, names, batch numbers, and any parameter/state values.
-"""
 function NetworkDynamics.describe_edges(nw::Network, extras...; parameters=true, states=true, batch=nothing)
     pairs = enumerate(nw.im.edgem);
     batches = map(idx -> findfirst(batch -> idx ∈ batch.indices, nw.layer.edgebatches), first.(pairs))

src/metadata.jl

@@ -771,5 +771,40 @@ function _has_changed_hash(aliased_cfs)
 end
 
 
+"""
+    describe_vertices(nw::Network, extras...; parameters=true, states=true, batch=nothing)
+
+Creates a DataFrame containing information about the vertices in a Network.
+
+# Arguments
+- `nw::Network`: The network to describe
+- `extras...`: Additional pairs of (key, function) to include as columns,
+   where the function gets the [`VertexModel`](@ref) as its only parameter
+   to extract a custom metadata field for example..
+- `parameters=true`: Whether to include parameter values
+- `states=true`: Whether to include state values
+- `batch=nothing`: Optionally filter by specific batches
+
+# Returns
+A DataFrame with columns for vertex indices, names, batch numbers, and any parameter/state values.
+"""
 function describe_vertices end
+
+"""
+    describe_edges(nw::Network, extras...; parameters=true, states=true, batch=nothing)
+
+Creates a DataFrame containing information about the edges in a Network.
+
+# Arguments
+- `nw::Network`: The network to describe
+- `extras...`: Additional pairs of (key, function) to include as columns,
+   where the function gets the [`EdgeModel`](@ref) as its only parameter
+   to extract a custom metadata field for example..
+- `parameters=true`: Whether to include parameter values
+- `states=true`: Whether to include state values
+- `batch=nothing`: Optionally filter by specific batches
+
+# Returns
+A DataFrame with columns for edge indices, source-destination pairs, names, batch numbers, and any parameter/state values.
+"""
 function describe_edges end