Skip to content

Update doc in statsviz.go #137

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arl merged 1 commit into from
Oct 17, 2025
Merged

Update doc in statsviz.go #137

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions statsviz.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
// Package statsviz allows visualizing Go runtime metrics data in real time in
// your browser.
//
// Register a Statsviz HTTP handlers with your server's [http.ServeMux]
// Register Statsviz HTTP handlers with your server's [http.ServeMux]
// (preferred method):
//
// mux := http.NewServeMux()
// statsviz.Register(mux)
//
// Alternatively, you can register with [http.DefaultServeMux]:
// Alternatively, you can register with [http.DefaultServeMux]
// though you shouldn't do that in production:
//
// ss := statsviz.NewServer()
// ss.Register(http.DefaultServeMux)
Expand All @@ -27,7 +28,7 @@
//
// # Advanced usage:
//
// If you want more control over Statsviz HTTP handlers, examples are:
// If you want more control over Statsviz HTTP handlers, for examples if:
// - you're using some HTTP framework
// - you want to place Statsviz handler behind some middleware
//
Expand Down
Loading