Remove unnecessary comments from markdown files (#6681)

Shopify · Jul 21, 2022 · 3b6d694 · 3b6d694
1 parent 6657ba4
commit 3b6d694
Show file tree

Hide file tree

Showing 136 changed files with 1,049 additions and 2,237 deletions.
diff --git a/.changeset/long-spoons-kiss.md b/.changeset/long-spoons-kiss.md
@@ -0,0 +1,6 @@
+---
+'@shopify/polaris': patch
+'polaris.shopify.com': patch
+---
+
+Removed comments and cleaned up markdown files
diff --git a/polaris-react/src/components/AccountConnection/README.md b/polaris-react/src/components/AccountConnection/README.md
@@ -52,7 +52,7 @@ merchants can connect to, followed by the word “account”. Write account conn
 - Mailchimp account
 - Instagram account
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -64,11 +64,13 @@ merchants can connect to, followed by the word “account”. Write account conn
 - Connect your Account
 - Instagram Account
 
+<!-- end -->
+
 ### Terms and conditions
 
 Clearly link to your terms and conditions and let merchants know about any additional costs of your service.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -85,7 +87,7 @@ Learn about terms, conditions, and payment details.
 
 Always use the verb Connect in the button of the account connection component. When merchants click or tap “Connect” it should open up your platform or service’s authorization page in a new browser window.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/ActionList/README.md b/polaris-react/src/components/ActionList/README.md
@@ -34,7 +34,7 @@ Actions lists should:
 
 Each item in an action list should be clear and predictable. Merchants should be able to anticipate what will happen when they click on an action item.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -48,7 +48,7 @@ Buy
 
 Each item in an action list should always lead with a strong verb that encourages action. To provide enough context use the {verb}+{noun} format unless the action is clear with a single verb.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -64,7 +64,7 @@ Each item in an action list should always lead with a strong verb that encourage
 
 Each item in an action list should be scannable avoiding unnecessary words and articles such as the, an, or a.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/Autocomplete/README.md b/polaris-react/src/components/Autocomplete/README.md
@@ -911,7 +911,7 @@ The autocomplete list displays below the text field or other control by default
 
 Autocomplete features can be challenging for merchants with visual, motor, and cognitive disabilities. Even when they’re built using best practices, these features can be difficult to use with some assistive technologies. Merchants should always be able to search, enter data, or perform other activities without relying on the autocomplete.
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/Badge/README.md b/polaris-react/src/components/Badge/README.md
@@ -61,7 +61,7 @@ The available badges for fulfillment status are:
 - Unfulfilled
 - Restocked
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Don’t
 

diff --git a/polaris-react/src/components/Banner/README.md b/polaris-react/src/components/Banner/README.md
@@ -80,7 +80,7 @@ Body content should:
 - Explain how to resolve the issue, particularly for warning and critical
   banners
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -101,7 +101,7 @@ Buttons and links should be:
   happen when they click a button. Never deceive merchants by mislabeling a
   button.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -117,7 +117,7 @@ Buy
   action. To provide enough context to merchants use the {verb}+{noun} format on
   buttons except in the case of common actions like Save, Close, Cancel, or OK.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -131,7 +131,7 @@ Try Apple Pay
 
 - Scannable: avoid unnecessary words and articles such as the, an, or a.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -147,7 +147,7 @@ Link text should:
 
 - Set the expectation of where merchants will be taken
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -162,7 +162,7 @@ Order
 - Use consistent content to label navigation. For example, if a navigational
   link leads to a page called Orders, label the link Orders.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -182,7 +182,7 @@ Body content should be:
   what actions are available to them (especially something new). Don’t use
   permissive language like “you can”.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -199,7 +199,7 @@ Now you can get performance data for all your sales channels.
 - Clear: use the verb “need” to help merchants understand when they’re required
   to do something.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -455,7 +455,7 @@ Always include [inline error](https://polaris.shopify.com/components/inline-erro
 
 To learn about creating helpful and accessible error message text, see the guidelines for [error messages](https://polaris.shopify.com/patterns/error-messages).
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/Button/README.md b/polaris-react/src/components/Button/README.md
@@ -356,7 +356,7 @@ To help support merchants who use speech activation software as well as sighted
 
 When possible, give the button visible text that clearly conveys its purpose without the use of `accessibilityLabel`. When no additional content is needed, duplicating the button text with `accessibilityLabel` isn’t necessary.
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 
@@ -391,7 +391,7 @@ When you use the button component to create a link to an external resource:
 
 For more information on making accessible links, see the [link component](https://polaris.shopify.com/components/link).
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/CalloutCard/README.md b/polaris-react/src/components/CalloutCard/README.md
@@ -58,7 +58,7 @@ Body content should be:
   what actions are available to them (especially something new). Don’t use
   permissive language like “you can”.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -75,7 +75,7 @@ Now you can get performance data for all your sales channels.
 - Clear: use the verb “need” to help merchants understand when they’re required
   to do something
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -95,7 +95,7 @@ Buttons should be:
 
 Clear and predictable: merchants should be able to anticipate what will happen when they click a button. Never deceive merchants by mislabeling a button.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -111,7 +111,7 @@ Buy
   action. To provide enough context to merchants use the {verb}+{noun} format on
   buttons except in the case of common actions like Save, Close, Cancel, or OK.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -125,7 +125,7 @@ View your settings
 
 - Scannable: avoid unnecessary words and articles such as the, an, or a.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/Caption/README.md b/polaris-react/src/components/Caption/README.md
@@ -38,7 +38,7 @@ Caption text size is smaller than the recommended size for general reading. On w
 
 Captions are primarily used in [data visualizations](https://polaris.shopify.com/design/data-visualizations). Stick to a few words and don’t use this component for complete sentences or longer content.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/Card/README.md b/polaris-react/src/components/Card/README.md
@@ -59,7 +59,7 @@ Body content should be:
   actions are available to them (especially something new). Don’t use permissive
   language like “you can”.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -76,7 +76,7 @@ Now you can get performance data for all your sales channels.
 - Clear: use the verb “need” to help merchants understand when they’re required
   to do something.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -97,7 +97,7 @@ Buttons should be:
 - Clear and predictable: merchants should be able to anticipate what will happen
   when they click a button. Never deceive merchants by mislabeling a button.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -115,7 +115,7 @@ Action-led: buttons should always lead with a strong verb that encourages
 action. To provide enough context to merchants use the {verb}+{noun} format on
 buttons except in the case of common actions like Save, Close, Cancel, or OK.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -131,7 +131,7 @@ buttons except in the case of common actions like Save, Close, Cancel, or OK.
 
 Scannable: Avoid unnecessary words and articles such as the, an, or a.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/Checkbox/README.md b/polaris-react/src/components/Checkbox/README.md
@@ -46,7 +46,7 @@ Lists that use checkboxes should:
 
 - Start with a capital letter
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 
@@ -64,7 +64,7 @@ Lists that use checkboxes should:
 
 - Not use commas or semicolons at the end of each line
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 
@@ -83,7 +83,7 @@ Lists that use checkboxes should:
 - In the rare case where the checkbox is asking merchants to agree to terms
   or service, use the first person
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/ChoiceList/README.md b/polaris-react/src/components/ChoiceList/README.md
@@ -46,7 +46,7 @@ List titles should:
 - Help merchants understand how the items in the list are grouped together, or
   should explain what kind of choice merchants are making
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -65,7 +65,7 @@ Pick one
 - It the title introduces the list, it should end with a colon
 - Should be written in sentence case
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -79,7 +79,7 @@ Shipping Options
 
 ### Not use colons
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 
@@ -99,7 +99,7 @@ Every item in a choice list should:
 - Not use commas or semicolons at the end of each line
 - Be written in sentence case (the first word capitalized, the rest lowercase)
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/Combobox/README.md b/polaris-react/src/components/Combobox/README.md
@@ -803,7 +803,7 @@ The `Combobox` popover displays below the text field or other control by default
 
 `Combobox` features can be challenging for merchants with visual, motor, and cognitive disabilities. Even when they’re built using best practices, these features can be difficult to use with some assistive technologies. Merchants should always be able to search, enter data, or perform other activities without relying on the combobox.
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/ContextualSaveBar/README.md b/polaris-react/src/components/ContextualSaveBar/README.md
@@ -43,7 +43,7 @@ The standard message content is
 - “Unsaved changes” when editing existing content
 - “Unsaved {resource name}” when creating a new object
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -59,7 +59,7 @@ The standard message content is
 
 Actions in the contextual save bar component should consist of a strong verb that encourages action. They should not include a noun.
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 

diff --git a/polaris-react/src/components/DataTable/README.md b/polaris-react/src/components/DataTable/README.md
@@ -1014,7 +1014,7 @@ Headers should:
 - Include units of measurement symbols so they aren’t repeated throughout the columns
 - Use sentence case (first word capitalized, rest lowercase)
 
-<!-- usagelist -->
+<!-- dodont -->
 
 #### Do
 
@@ -1052,7 +1052,7 @@ Native HTML tables provide a large amount of structural information to screen re
 
 Sortable tables use the `aria-sort` attribute to convey which columns are sortable (and in what direction). They also use `aria-label` on sorting buttons to convey what activating the button will do.
 
-<!-- usageblock -->
+<!-- dodont -->
 
 #### Do