Skip to content

Commit

Permalink
chore(services/redis): Fix docs & comments typos (#4306)
Browse files Browse the repository at this point in the history
  • Loading branch information
AJIOB authored Mar 3, 2024
1 parent 5f1d5d1 commit 6925aef
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
4 changes: 3 additions & 1 deletion core/src/services/redis/backend.rs
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ impl RedisBuilder {
/// currently supported schemes:
/// - no scheme: will be seen as "tcp"
/// - "tcp" or "redis": unsecured redis connections
/// - "rediss": secured redis connections
/// - "unix" or "redis+unix": unix socket connection
pub fn endpoint(&mut self, endpoint: &str) -> &mut Self {
if !endpoint.is_empty() {
Expand All @@ -130,11 +131,12 @@ impl RedisBuilder {
}

/// set the network address of redis cluster service.
/// This parameter is mutually exclusive with the endponit parameter.
/// This parameter is mutually exclusive with the endpoint parameter.
///
/// currently supported schemes:
/// - no scheme: will be seen as "tcp"
/// - "tcp" or "redis": unsecured redis connections
/// - "rediss": secured redis connections
/// - "unix" or "redis+unix": unix socket connection
pub fn cluster_endpoints(&mut self, cluster_endpoints: &str) -> &mut Self {
if !cluster_endpoints.is_empty() {
Expand Down
2 changes: 1 addition & 1 deletion core/src/services/redis/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This service can be used to:

- `root`: Set the working directory of `OpenDAL`
- `endpoint`: Set the network address of redis server
- `cluster_endpoints`: Set the network address of redis cluster server. This parameter is mutually exclusive with the `endponit` parameter.
- `cluster_endpoints`: Set the network address of redis cluster server. This parameter is mutually exclusive with the `endpoint` parameter.
- `username`: Set the username of Redis
- `password`: Set the password for authentication
- `db`: Set the DB of redis
Expand Down

0 comments on commit 6925aef

Please sign in to comment.