]> Cypherpunks repositories - gostls13.git/commitdiff
spec: better comment in example for type definition
authorgriesemer <gri@golang.org>
Fri, 11 Aug 2017 14:51:40 +0000 (16:51 +0200)
committerRobert Griesemer <gri@golang.org>
Mon, 14 Aug 2017 13:35:43 +0000 (13:35 +0000)
The old comment for the example

type PtrMutex *Mutex

talked about the method set of the base type of PtrMutex.
It's more direct and clearer to talk about the underlying
type of PtrMutex for this specific example.
Also removed link inside pre-formatted region of text.

Fixes #20900.

Change-Id: Ie37340e53670e34ebe13e780ba8ccb1bba67795c
Reviewed-on: https://go-review.googlesource.com/55070
Reviewed-by: Rob Pike <r@golang.org>
Reviewed-by: Ian Lance Taylor <iant@golang.org>
doc/go_spec.html

index 6642869d0c5ba87df81b045cd9a63c81b4385881..184b6960f4e86d3eeb6db45e7bac7040de7bb04b 100644 (file)
@@ -1,6 +1,6 @@
 <!--{
        "Title": "The Go Programming Language Specification",
-       "Subtitle": "Version of June 28, 2017",
+       "Subtitle": "Version of August 14, 2017",
        "Path": "/ref/spec"
 }-->
 
@@ -1946,7 +1946,7 @@ func (m *Mutex) Unlock()  { /* Unlock implementation */ }
 // NewMutex has the same composition as Mutex but its method set is empty.
 type NewMutex Mutex
 
-// The method set of the <a href="#Pointer_types">base type</a> of PtrMutex remains unchanged,
+// The method set of PtrMutex's underlying type *Mutex remains unchanged,
 // but the method set of PtrMutex is empty.
 type PtrMutex *Mutex