Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JBlaschke committed Dec 31, 2023
1 parent 0685838 commit 8fc464f
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions src/highlevel_api.jl
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,17 @@ function is_visible(obj::Object; minimal=true)
end

"""
print_topology([io::IO = stdout, obj::Object = gettopology()])
print_topology(
io::IO = stdout, obj::Object = gettopology();
indent = "", newline = false, prefix = "", minimal=true
)
Prints the topology of the given `obj` as a tree to `io`.
Prints the topology of the given `obj` as a tree to `io`.
**Note:** some systems have a great deal of extra PCI devices (think USB
bridges, and the many many device classes on custom systems like HPC clusters).
In order to mimmic the behaviour of the `lstopo` command, we ommit these devices
unless `minimal=false`.
"""
function print_topology(
io::IO = stdout, obj::Object = gettopology();
Expand Down

0 comments on commit 8fc464f

Please sign in to comment.