Skip to content

Commit

Permalink
Capitalize some resource docs (#5229)
Browse files Browse the repository at this point in the history
Improve our docs generation a tiny bit

Signed-off-by: Tim Smith <tsmith84@gmail.com>
  • Loading branch information
tas50 authored Feb 17, 2025
1 parent 0162b01 commit a70968d
Show file tree
Hide file tree
Showing 8 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion providers/arista/resources/arista.lr
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ arista.eos.stp.mst @defaults("instanceId name") {
rootBridge dict
// Regional root bridge information
regionalRootBridge dict
// interfaces on the specified MST instances
// Interfaces on the specified MST instances
interfaces []arista.eos.spt.mstInterface
}

Expand Down
10 changes: 5 additions & 5 deletions providers/aws/resources/aws.lr
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ private aws.waf.rule.statement.ipsetreferencestatement {
ruleName string
// ID of the statement
statementID string
// arn of the ipset
// ARN of the ipset
arn string
// ipSetForwardedIPConfig
ipSetForwardedIPConfig aws.waf.rule.statement.ipsetreferencestatement.ipsetforwardedipconfig
Expand Down Expand Up @@ -633,7 +633,7 @@ private aws.waf.ipset @defaults("name") {
description string
// Address type: ipv4 or ipv6
addressType string
// list of IP addresses
// List of IP addresses
addresses dict
}

Expand Down Expand Up @@ -717,7 +717,7 @@ aws.iam {
// Entry in AWS IAM credential report
private aws.iam.usercredentialreportentry @defaults("arn") {
init(properties map[string]string)
// properties on the IAM user credential report
// Properties on the IAM user credential report
properties map[string]string

// ARN for the credential report
Expand Down Expand Up @@ -816,7 +816,7 @@ private aws.iam.instanceProfile @defaults("arn instanceProfileId") {
instanceProfileName string
// Tags for the instance profile
tags map[string]string
// role attached to the instanceProfile
// Role attached to the instanceProfile
iamRoles() []aws.iam.role
}

Expand Down Expand Up @@ -2523,7 +2523,7 @@ private aws.ecr.image @defaults("uri region") {
region string
// ARN for the image
arn string
// uri for the image repository
// URI for the image repository
uri string
// Time the image was pushed
pushedAt time
Expand Down
4 changes: 2 additions & 2 deletions providers/cloudformation/resources/cloudformation.lr
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ cloudformation.template @defaults("description") {
resources() []cloudformation.resource
// Template outputs
outputs() []cloudformation.output
// supported resource types
// Supported resource types
types() []string
}

Expand All @@ -52,4 +52,4 @@ cloudformation.output @defaults("name") {
name string
// Output properties
properties map[string]dict
}
}
4 changes: 2 additions & 2 deletions providers/equinix/resources/equinix.lr
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ private equinix.metal.user @defaults("email") {
equinix.metal.sshkey @defaults("label") {
// ID of the SSH key
id string
// label of the SSH key
// Label of the SSH key
label string
// Key
key string
Expand Down Expand Up @@ -134,4 +134,4 @@ equinix.metal.device {
spotInstance bool
// Operating system
os dict
}
}
2 changes: 1 addition & 1 deletion providers/gcp/resources/gcp.lr
Original file line number Diff line number Diff line change
Expand Up @@ -432,7 +432,7 @@ private gcp.project.computeService.instance @defaults("name") {
minCpuPlatform string
// Network configurations for the instance
networkInterfaces []dict
// private IPv6 google access type for the VM
// Private IPv6 google access type for the VM
privateIpv6GoogleAccess string
// Reservations from which this instance can consume
reservationAffinity dict
Expand Down
4 changes: 2 additions & 2 deletions providers/oci/resources/oci.lr
Original file line number Diff line number Diff line change
Expand Up @@ -274,12 +274,12 @@ private oci.objectStorage.bucket {
publicAccessType() string
// Storage tier type
storageTier() string
// auto tiering status
// Auto tiering status
autoTiering() string
// Bucket versioning
versioning() string
// Whether events are emitted for object state changes
objectEventsEnabled() bool
// Whether the bucket is a replication source
replicationEnabled() bool
}
}
2 changes: 1 addition & 1 deletion providers/os/resources/os.lr
Original file line number Diff line number Diff line change
Expand Up @@ -1304,7 +1304,7 @@ npm.packages {

init(path? string)

// optional path to search for packages
// Optional path to search for packages
path string

// Root Package (may not exist)
Expand Down
2 changes: 1 addition & 1 deletion providers/terraform/resources/terraform.lr
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ terraform.state {
outputs() []terraform.state.output
// Root module which consists resources defined in .tf files
rootModule() terraform.state.module
// flat list of all modules
// Flat list of all modules
modules() []terraform.state.module
// A flat list of all resources across all modules
resources() []terraform.state.resource
Expand Down

0 comments on commit a70968d

Please sign in to comment.