Skip to content

Commit f6a3ed8

Browse files
authored
GODRIVER-209 Fix documentation for deprecating MONGODB-CR (#718)
1 parent 588e0a6 commit f6a3ed8

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

x/mongo/driver/auth/mongodbcr.go

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,8 @@ import (
2121

2222
// MONGODBCR is the mechanism name for MONGODB-CR.
2323
//
24-
// The MONGODB-CR authentication mechanism is deprecated in MongoDB 4.0.
24+
// The MONGODB-CR authentication mechanism is deprecated in MongoDB 3.6 and removed in
25+
// MongoDB 4.0.
2526
const MONGODBCR = "MONGODB-CR"
2627

2728
func newMongoDBCRAuthenticator(cred *Cred) (Authenticator, error) {
@@ -34,7 +35,8 @@ func newMongoDBCRAuthenticator(cred *Cred) (Authenticator, error) {
3435

3536
// MongoDBCRAuthenticator uses the MONGODB-CR algorithm to authenticate a connection.
3637
//
37-
// The MONGODB-CR authentication mechanism is deprecated in MongoDB 4.0.
38+
// The MONGODB-CR authentication mechanism is deprecated in MongoDB 3.6 and removed in
39+
// MongoDB 4.0.
3840
type MongoDBCRAuthenticator struct {
3941
DB string
4042
Username string
@@ -43,7 +45,8 @@ type MongoDBCRAuthenticator struct {
4345

4446
// Auth authenticates the connection.
4547
//
46-
// The MONGODB-CR authentication mechanism is deprecated in MongoDB 4.0.
48+
// The MONGODB-CR authentication mechanism is deprecated in MongoDB 3.6 and removed in
49+
// MongoDB 4.0.
4750
func (a *MongoDBCRAuthenticator) Auth(ctx context.Context, cfg *Config) error {
4851

4952
db := a.DB

0 commit comments

Comments
 (0)