Skip to content

Commit 197eb5a

Browse files
authored
(DOCSP-36037) Copy reviews recent changes in the Atlas Go SDK docs (#264)
1 parent ddd022d commit 197eb5a

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

docs/doc_1_concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ If you encounter any problems with methods marked as experimental, feel free to
5757

5858
## Read Only and Write Only Fields
5959

60-
Each SDK request and response might contain read or write only fields as identified by the [documentation](https://github.com/mongodb/atlas-sdk-go/blob/main/docs/doc_last_reference.md#documentation-for-models) and the Go doc comments.
60+
Each SDK request and response might contain read-only or write-only fields as identified by the [documentation](https://github.com/mongodb/atlas-sdk-go/blob/main/docs/doc_last_reference.md#documentation-for-models) and the Go doc comments.
6161

6262
We use GoDoc comments to annotate fields as read and write only:
6363

docs/doc_5_best_practices.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ When you have confirmed that the `time.Time pointer` is non-nil, you can safely
5656

5757
## Working with Pointers
5858

59-
SDK pointers are utilized to denote optional values in the Go programming language:
59+
The Atlas Go SDK utilizes SDK pointers to denote optional values in the Go programming language:
6060

6161
```golang
6262
type Data struct {
@@ -65,23 +65,23 @@ type Data struct {
6565
}
6666
```
6767

68-
In the example above, the string value is optional, and it won't be sent to the server if not explicitly set.
68+
In the example above, the string value is optional, and it won't be sent to the server if you don't explicitly set it.
6969

7070
## Working with Arrays
7171

72-
All arrays in the SDK are represented as pointers:
72+
The Atlas Go SDK represents all arrays as pointers:
7373

7474
```golang
7575
type Data struct {
7676
Results *[]DataRole `json:"results,omitempty"`
7777
}
7878
```
7979

80-
Scenarios for using pointers with arrays:
80+
The following scenarios use pointers with arrays:
8181

82-
1. Update request containing an empty array (resetting the field values):
82+
1. Update a request containing an empty array (resetting the field values):
8383

84-
If a struct property is explicitly set to an empty array, the SDK will send an empty array request to the Atlas API.
84+
If you explicitly set a struct property to an empty array, the SDK will send an empty array request to the Atlas API.
8585

8686
```golang
8787
data := Data{
@@ -90,9 +90,9 @@ data := Data{
9090
}
9191
```
9292

93-
2. Update request without updating the array field:
93+
2. Update a request without updating the array field:
9494

95-
When performing an update operation, we recommend the struct property not to be present.
95+
When performing an update operation, we recommend that you don't set the struct property.
9696

9797
```golang
9898
data := Data{
@@ -101,7 +101,7 @@ data := Data{
101101
}
102102
```
103103

104-
These practices ensure accurate handling of optional values and array updates in the SDK when working with pointers in Golang.
104+
These practices ensure accurate handling of optional values and array updates in the SDK when you work with pointers in Golang.
105105

106106
## Working with Binary Responses
107107

0 commit comments

Comments
 (0)