Documentation: Appropriate formatting for callouts

[sh-cho]

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or "me too" comments, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment. If the issue is assigned to the "modular-magician" user, it is either in the process of being autogenerated, or is planned to be autogenerated soon. If the issue is assigned to a user, that user is claiming responsibility for the issue. If the issue is assigned to "hashibot", a community member has claimed the issue already.

Description

In some documents, Callouts(->, ~>, !>) are not rendered properly.

ex) compute_region_backend_service

diff --git a/website/docs/r/compute_region_backend_service.html.markdown b/website/docs/r/compute_region_backend_service.html.markdown
index 8a18a0749..fb0af42de 100644
--- a/website/docs/r/compute_region_backend_service.html.markdown
+++ b/website/docs/r/compute_region_backend_service.html.markdown
@@ -525,10 +525,11 @@ The following arguments are supported:
 
 * `capacity_scaler` -
   (Optional)
   A multiplier applied to the group's maximum servicing capacity
   (based on UTILIZATION, RATE or CONNECTION).
+
   ~>**NOTE**: This field cannot be set for
   INTERNAL region backend services (default loadBalancingScheme),
   but is required for non-INTERNAL backend service. The total
   capacity_scaler for all backends must be non-zero.
   A setting of 0 means the group is completely drained, offering

There is no empty line between 'description' and 'callout' and so callout is not printed.

With terraform doc preview tool, I can verify this.

            - !ruby/object:Api::Type::Double
              name: 'capacityScaler'
              description: |
                A multiplier applied to the group's maximum servicing capacity
                (based on UTILIZATION, RATE or CONNECTION).

                ~>**NOTE**: This field cannot be set for
                INTERNAL region backend services (default loadBalancingScheme),
                but is required for non-INTERNAL backend service. The total
                capacity_scaler for all backends must be non-zero.

                A setting of 0 means the group is completely drained, offering
                0% of its available Capacity. Valid range is [0.0,1.0].

https://github.com/GoogleCloudPlatform/magic-modules/blob/3b11c400e67463f49596de8ca53f5583a8f6845d/mmv1/products/compute/api.yaml#L1908-L1921

But newlines are already in 'description' paragraph, it looks like ignored somehow.

New or Affected Resource(s)

• guides
  • Google Provider Configuration Reference
• resources
  • google_app_engine_application
  • google_bigquery_routine
  • compute_region_backend_service
  • ...
• data sources
  • google_compute_instance_template
  • ...

(Just checked few documents only)