dns/dnsmessage: update Parser docs
The current API returns ErrSectionDone, not (nil,nil).
Change-Id: I95c721c6c198e7302b9154bc39617b502e3d62f9
GitHub-Last-Rev: c66bcff3b11bac48439712a2a6867857d26fb865
GitHub-Pull-Request: golang/net#181
Reviewed-on: https://go-review.googlesource.com/c/net/+/507955
Run-TryBot: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Reviewed-by: Damien Neil <dneil@google.com>
diff --git a/dns/dnsmessage/message.go b/dns/dnsmessage/message.go
index 1577d4a..37da3de 100644
--- a/dns/dnsmessage/message.go
+++ b/dns/dnsmessage/message.go
@@ -527,12 +527,14 @@
// When parsing is started, the Header is parsed. Next, each Question can be
// either parsed or skipped. Alternatively, all Questions can be skipped at
// once. When all Questions have been parsed, attempting to parse Questions
-// will return (nil, nil) and attempting to skip Questions will return
-// (true, nil). After all Questions have been either parsed or skipped, all
+// will return the [ErrSectionDone] error.
+// After all Questions have been either parsed or skipped, all
// Answers, Authorities and Additionals can be either parsed or skipped in the
// same way, and each type of Resource must be fully parsed or skipped before
// proceeding to the next type of Resource.
//
+// Parser is safe to copy to preserve the parsing state.
+//
// Note that there is no requirement to fully skip or parse the message.
type Parser struct {
msg []byte
