Skip to content

Commit

Permalink
Updates to godoc comments
Browse files Browse the repository at this point in the history
  • Loading branch information
mthadley committed Apr 29, 2024
1 parent d6fc0fe commit 26b01ab
Showing 1 changed file with 9 additions and 5 deletions.
14 changes: 9 additions & 5 deletions pkg/organizations/client.go
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,12 @@ const (
Pending OrganizationDomainDataState = "pending"
)

// OrganizationDomainData contains data used to create OrganizationDomain
// OrganizationDomainData contains data used to create an OrganizationDomain.
type OrganizationDomainData struct {
// The domain value
// The domain's value.
Domain string `json:"domain"`

// The domain state
// The domain's state.
State OrganizationDomainDataState `json:"state"`
}

Expand All @@ -150,7 +150,9 @@ type CreateOrganizationOpts struct {
// outside of the Organization's configured User Email Domains.
AllowProfilesOutsideOrganization bool `json:"allow_profiles_outside_organization"`

// [Deprecated] Domains of the Organization. Use DomainData instead.
// Domains of the Organization.
//
// Deprecated: Use DomainData instead.
Domains []string `json:"domains"`

// Domains of the Organization.
Expand All @@ -172,7 +174,9 @@ type UpdateOrganizationOpts struct {
// outside of the Organization's configured User Email Domains.
AllowProfilesOutsideOrganization bool

// [Deprecated] Domains of the Organization. Use DomainData instead.
// Domains of the Organization.
//
// Deprecated: Use DomainData instead.
Domains []string

// Domains of the Organization.
Expand Down

0 comments on commit 26b01ab

Please sign in to comment.