From 17c03b3b2d02f5a0823869ac9c4366b5d8ae9096 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pawe=C5=82=20Zuzelski?= Date: Thu, 4 Feb 2021 18:03:52 +0100 Subject: [PATCH] Clarify the godoc of the Children function. The previous godoc string was slightly confusing and only described information that can be deduced from the function signature. --- process/process.go | 3 ++- v3/process/process.go | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/process/process.go b/process/process.go index a50b4dc..a667ddf 100644 --- a/process/process.go +++ b/process/process.go @@ -476,7 +476,8 @@ func (p *Process) PageFaults() (*PageFaultsStat, error) { return p.PageFaultsWithContext(context.Background()) } -// Children returns a slice of Process of the process. +// Children returns the children of the process represented as a slice +// of pointers to Process type. func (p *Process) Children() ([]*Process, error) { return p.ChildrenWithContext(context.Background()) } diff --git a/v3/process/process.go b/v3/process/process.go index 6ef390a..6dd7167 100644 --- a/v3/process/process.go +++ b/v3/process/process.go @@ -487,7 +487,8 @@ func (p *Process) PageFaults() (*PageFaultsStat, error) { return p.PageFaultsWithContext(context.Background()) } -// Children returns a slice of Process of the process. +// Children returns the children of the process represented as a slice +// of pointers to Process type. func (p *Process) Children() ([]*Process, error) { return p.ChildrenWithContext(context.Background()) }