Skip to content

Commit 3478900

Browse files
committed
Improve markdown for attribute descriptions
- Ensure consistent usage of backticks for inline code. - Correct a typo in the `icon` attribute description.
1 parent 21bd3ee commit 3478900

File tree

5 files changed

+10
-10
lines changed

5 files changed

+10
-10
lines changed

internal/provider/group_data_source.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ func (d *GroupDataSource) Schema(ctx context.Context, req datasource.SchemaReque
9393
Computed: true,
9494
},
9595
"source": schema.StringAttribute{
96-
MarkdownDescription: "The source of the group. Either 'oidc' or 'user'.",
96+
MarkdownDescription: "The source of the group. Either `oidc` or `user`.",
9797
Computed: true,
9898
},
9999
"members": schema.SetNestedAttribute{
@@ -120,11 +120,11 @@ func (d *GroupDataSource) Schema(ctx context.Context, req datasource.SchemaReque
120120
Computed: true,
121121
},
122122
"status": schema.StringAttribute{
123-
MarkdownDescription: "The status of the member. Can be 'active', 'dormant' or 'suspended'.",
123+
MarkdownDescription: "The status of the member. Can be `active`, `dormant` or `suspended`.",
124124
Computed: true,
125125
},
126126
"login_type": schema.StringAttribute{
127-
MarkdownDescription: "The login type of the member. Can be 'oidc', 'token', 'password', 'github' or 'none'.",
127+
MarkdownDescription: "The login type of the member. Can be `oidc`, `token`, `password`, `github` or `none`.",
128128
Computed: true,
129129
},
130130
"theme_preference": schema.StringAttribute{

internal/provider/group_resource.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ func (r *GroupResource) Schema(ctx context.Context, req resource.SchemaRequest,
115115
},
116116
},
117117
"members": schema.SetAttribute{
118-
MarkdownDescription: "Members of the group, by ID. If null, members will not be added or removed by Terraform. To have a group resource with unmanaged members, but be able to read the members in Terraform, use `data.coderd_group`",
118+
MarkdownDescription: "Members of the group, by ID. If `null`, members will not be added or removed by Terraform. To have a group resource with unmanaged members, but be able to read the members in Terraform, use `data.coderd_group`",
119119
ElementType: UUIDType,
120120
Optional: true,
121121
},

internal/provider/user_data_source.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,12 +72,12 @@ func (d *UserDataSource) Schema(ctx context.Context, req datasource.SchemaReques
7272
Computed: true,
7373
},
7474
"roles": schema.SetAttribute{
75-
MarkdownDescription: "Roles assigned to the user. Valid roles are 'owner', 'template-admin', 'user-admin', and 'auditor'.",
75+
MarkdownDescription: "Roles assigned to the user. Valid roles are `owner`, `template-admin`, `user-admin`, and `auditor`.",
7676
Computed: true,
7777
ElementType: types.StringType,
7878
},
7979
"login_type": schema.StringAttribute{
80-
MarkdownDescription: "Type of login for the user. Valid types are 'none', 'password', 'github', and 'oidc'.",
80+
MarkdownDescription: "Type of login for the user. Valid types are `none`, `password', `github`, and `oidc`.",
8181
Computed: true,
8282
},
8383
"suspended": schema.BoolAttribute{

internal/provider/user_resource.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ func (r *UserResource) Schema(ctx context.Context, req resource.SchemaRequest, r
8989
Required: true,
9090
},
9191
"roles": schema.SetAttribute{
92-
MarkdownDescription: "Roles assigned to the user. Valid roles are 'owner', 'template-admin', 'user-admin', and 'auditor'.",
92+
MarkdownDescription: "Roles assigned to the user. Valid roles are `owner`, `template-admin`, `user-admin`, and `auditor`.",
9393
Computed: true,
9494
Optional: true,
9595
ElementType: types.StringType,
@@ -101,7 +101,7 @@ func (r *UserResource) Schema(ctx context.Context, req resource.SchemaRequest, r
101101
Default: setdefault.StaticValue(types.SetValueMust(types.StringType, []attr.Value{})),
102102
},
103103
"login_type": schema.StringAttribute{
104-
MarkdownDescription: "Type of login for the user. Valid types are 'none', 'password', 'github', and 'oidc'.",
104+
MarkdownDescription: "Type of login for the user. Valid types are `none`, `password`, `github`, and `oidc`.",
105105
Computed: true,
106106
Optional: true,
107107
Validators: []validator.String{
@@ -113,7 +113,7 @@ func (r *UserResource) Schema(ctx context.Context, req resource.SchemaRequest, r
113113
},
114114
},
115115
"password": schema.StringAttribute{
116-
MarkdownDescription: "Password for the user. Required when login_type is 'password'. Passwords are saved into the state as plain text and should only be used for testing purposes.",
116+
MarkdownDescription: "Password for the user. Required when `login_type` is `password`. Passwords are saved into the state as plain text and should only be used for testing purposes.",
117117
Optional: true,
118118
Sensitive: true,
119119
},

internal/provider/workspace_proxy_resource.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ func (r *WorkspaceProxyResource) Schema(ctx context.Context, req resource.Schema
6060
Computed: true,
6161
},
6262
"icon": schema.StringAttribute{
63-
MarkdownDescription: "Relative path or external URL that specifes an icon to be displayed in the dashboard.",
63+
MarkdownDescription: "Relative path or external URL that specifies an icon to be displayed in the dashboard.",
6464
Required: true,
6565
},
6666
"session_token": schema.StringAttribute{

0 commit comments

Comments
 (0)