fix some incorrect formatting in the documentation

[gchappel]

There was some bad formatting in the variables.tf file (and ultimately the README.md file) which was obscuring some important text in the Description field of the bucket_name Input

[google-cla]

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

---

What to do if you already signed the CLA

Individual signers

• It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

• Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
• The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
• The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

[comment-bot-dev]

Thanks for the PR! 🚀
Unfortunately it looks like some of our CI checks failed. See the Contributing Guide for details.

• ⚠️check_documentation
  The documentation needs to be regenerated. Please run make generate_docs.

Checking for documentation generation
diff -r '--exclude=.terraform' '--exclude=.kitchen' '--exclude=.git' '--exclude=autogen' '--exclude=*.tfvars' /workspace/README.md /tmp/tmp.0XaS15eVeo/generate_docs/workspace/README.md
40,66c40,66
< | <a name="input_bucket_force_destroy"></a> [bucket\_force\_destroy](#input\_bucket\_force\_destroy) | When deleting the GCS bucket containing the cloud function, delete all objects in the bucket first. | `bool` | `true` | no |
< | <a name="input_bucket_name"></a> [bucket\_name](#input\_bucket\_name) | The name to apply to the bucket. Will default to a string of `<project-id>-scheduled-function-<XXXX>` with `XXXX` being random characters. | `string` | `""` | no |
< | <a name="input_function_available_memory_mb"></a> [function\_available\_memory\_mb](#input\_function\_available\_memory\_mb) | The amount of memory in megabytes allotted for the function to use. | `number` | `256` | no |
< | <a name="input_function_description"></a> [function\_description](#input\_function\_description) | The description of the function. | `string` | `"Processes log export events provided through a Pub/Sub topic subscription."` | no |
< | <a name="input_function_entry_point"></a> [function\_entry\_point](#input\_function\_entry\_point) | The name of a method in the function source which will be invoked when the function is executed. | `string` | n/a | yes |
< | <a name="input_function_environment_variables"></a> [function\_environment\_variables](#input\_function\_environment\_variables) | A set of key/value environment variable pairs to assign to the function. | `map(string)` | `{}` | no |
< | <a name="input_function_event_trigger_failure_policy_retry"></a> [function\_event\_trigger\_failure\_policy\_retry](#input\_function\_event\_trigger\_failure\_policy\_retry) | A toggle to determine if the function should be retried on failure. | `bool` | `false` | no |
< | <a name="input_function_labels"></a> [function\_labels](#input\_function\_labels) | A set of key/value label pairs to assign to the function. | `map(string)` | `{}` | no |
< | <a name="input_function_name"></a> [function\_name](#input\_function\_name) | The name to apply to the function | `string` | n/a | yes |
< | <a name="input_function_runtime"></a> [function\_runtime](#input\_function\_runtime) | The runtime in which the function will be executed. | `string` | `"nodejs10"` | no |
< | <a name="input_function_service_account_email"></a> [function\_service\_account\_email](#input\_function\_service\_account\_email) | The service account to run the function as. | `string` | `""` | no |
< | <a name="input_function_source_archive_bucket_labels"></a> [function\_source\_archive\_bucket\_labels](#input\_function\_source\_archive\_bucket\_labels) | A set of key/value label pairs to assign to the function source archive bucket. | `map(string)` | `{}` | no |
< | <a name="input_function_source_dependent_files"></a> [function\_source\_dependent\_files](#input\_function\_source\_dependent\_files) | A list of any terraform created `local_file`s that the module will wait for before creating the archive. | <pre>list(object({<br>    filename = string<br>    id       = string<br>  }))</pre> | `[]` | no |
< | <a name="input_function_source_directory"></a> [function\_source\_directory](#input\_function\_source\_directory) | The contents of this directory will be archived and used as the function source. | `string` | n/a | yes |
< | <a name="input_function_timeout_s"></a> [function\_timeout\_s](#input\_function\_timeout\_s) | The amount of time in seconds allotted for the execution of the function. | `number` | `60` | no |
< | <a name="input_grant_token_creator"></a> [grant\_token\_creator](#input\_grant\_token\_creator) | Specify true if you want to add token creator role to the default Pub/Sub SA | `bool` | `false` | no |
< | <a name="input_job_description"></a> [job\_description](#input\_job\_description) | Addition text to describe the job | `string` | `""` | no |
< | <a name="input_job_name"></a> [job\_name](#input\_job\_name) | The name of the scheduled job to run | `string` | `null` | no |
< | <a name="input_job_schedule"></a> [job\_schedule](#input\_job\_schedule) | The job frequency, in 5-field, unix-cron syntax (excluding seconds) | `string` | `"*/2 * * * *"` | no |
< | <a name="input_message_data"></a> [message\_data](#input\_message\_data) | The data to send in the topic message. | `string` | `"dGVzdA=="` | no |
< | <a name="input_project_id"></a> [project\_id](#input\_project\_id) | The ID of the project where the resources will be created | `string` | n/a | yes |
< | <a name="input_region"></a> [region](#input\_region) | The region in which resources will be applied. | `string` | n/a | yes |
< | <a name="input_scheduler_job"></a> [scheduler\_job](#input\_scheduler\_job) | An existing Cloud Scheduler job instance | `object({ name = string })` | `null` | no |
< | <a name="input_time_zone"></a> [time\_zone](#input\_time\_zone) | The timezone to use in scheduler | `string` | `"Etc/UTC"` | no |
< | <a name="input_topic_name"></a> [topic\_name](#input\_topic\_name) | Name of pubsub topic connecting the scheduled job and the function | `string` | `"test-topic"` | no |
< | <a name="input_vpc_connector"></a> [vpc\_connector](#input\_vpc\_connector) | The VPC Network Connector that this cloud function can connect to. It should be set up as fully-qualified URI. The format of this field is projects//locations//connectors/*. | `string` | `null` | no |
< | <a name="input_vpc_connector_egress_settings"></a> [vpc\_connector\_egress\_settings](#input\_vpc\_connector\_egress\_settings) | The egress settings for the connector, controlling what traffic is diverted through it. Allowed values are ALL\_TRAFFIC and PRIVATE\_RANGES\_ONLY. If unset, this field preserves the previously set value. | `string` | `null` | no |
---
> | bucket\_force\_destroy | When deleting the GCS bucket containing the cloud function, delete all objects in the bucket first. | `bool` | `true` | no |
> | bucket\_name | The name to apply to the bucket. Will default to a string of `<project-id>-scheduled-function-<XXXX>` with `XXXX` being random characters. | `string` | `""` | no |
> | function\_available\_memory\_mb | The amount of memory in megabytes allotted for the function to use. | `number` | `256` | no |
> | function\_description | The description of the function. | `string` | `"Processes log export events provided through a Pub/Sub topic subscription."` | no |
> | function\_entry\_point | The name of a method in the function source which will be invoked when the function is executed. | `string` | n/a | yes |
> | function\_environment\_variables | A set of key/value environment variable pairs to assign to the function. | `map(string)` | `{}` | no |
> | function\_event\_trigger\_failure\_policy\_retry | A toggle to determine if the function should be retried on failure. | `bool` | `false` | no |
> | function\_labels | A set of key/value label pairs to assign to the function. | `map(string)` | `{}` | no |
> | function\_name | The name to apply to the function | `string` | n/a | yes |
> | function\_runtime | The runtime in which the function will be executed. | `string` | `"nodejs10"` | no |
> | function\_service\_account\_email | The service account to run the function as. | `string` | `""` | no |
> | function\_source\_archive\_bucket\_labels | A set of key/value label pairs to assign to the function source archive bucket. | `map(string)` | `{}` | no |
> | function\_source\_dependent\_files | A list of any terraform created `local_file`s that the module will wait for before creating the archive. | <pre>list(object({<br>    filename = string<br>    id       = string<br>  }))</pre> | `[]` | no |
> | function\_source\_directory | The contents of this directory will be archived and used as the function source. | `string` | n/a | yes |
> | function\_timeout\_s | The amount of time in seconds allotted for the execution of the function. | `number` | `60` | no |
> | grant\_token\_creator | Specify true if you want to add token creator role to the default Pub/Sub SA | `bool` | `false` | no |
> | job\_description | Addition text to describe the job | `string` | `""` | no |
> | job\_name | The name of the scheduled job to run | `string` | `null` | no |
> | job\_schedule | The job frequency, in 5-field, unix-cron syntax (excluding seconds) | `string` | `"*/2 * * * *"` | no |
> | message\_data | The data to send in the topic message. | `string` | `"dGVzdA=="` | no |
> | project\_id | The ID of the project where the resources will be created | `string` | n/a | yes |
> | region | The region in which resources will be applied. | `string` | n/a | yes |
> | scheduler\_job | An existing Cloud Scheduler job instance | `object({ name = string })` | `null` | no |
> | time\_zone | The timezone to use in scheduler | `string` | `"Etc/UTC"` | no |
> | topic\_name | Name of pubsub topic connecting the scheduled job and the function | `string` | `"test-topic"` | no |
> | vpc\_connector | The VPC Network Connector that this cloud function can connect to. It should be set up as fully-qualified URI. The format of this field is projects//locations//connectors/\*. | `string` | `null` | no |
> | vpc\_connector\_egress\_settings | The egress settings for the connector, controlling what traffic is diverted through it. Allowed values are ALL\_TRAFFIC and PRIVATE\_RANGES\_ONLY. If unset, this field preserves the previously set value. | `string` | `null` | no |
72,74c72,75
< | <a name="output_name"></a> [name](#output\_name) | The name of the job created |
< | <a name="output_pubsub_topic_name"></a> [pubsub\_topic\_name](#output\_pubsub\_topic\_name) | PubSub topic name |
< | <a name="output_scheduler_job"></a> [scheduler\_job](#output\_scheduler\_job) | The Cloud Scheduler job instance |
---
> | name | The name of the job created |
> | pubsub\_topic\_name | PubSub topic name |
> | scheduler\_job | The Cloud Scheduler job instance |
> 
Error: Documentation generation has not been run, please run the
'make docker_generate_docs' command and commit the above changes.

[google-cla]

Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please visit https://cla.developers.google.com/ to sign.

Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.

---

What to do if you already signed the CLA

Individual signers

• It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.

Corporate signers

• Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
• The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
• The email used to register you as an authorized contributor must also be attached to your GitHub account.

ℹ️ Googlers: Go here for more info.

[github-actions]

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days