Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Markdown linting: Enable rule MD036 (emphasis used instead of a header) #6023

Merged
merged 5 commits into from
Nov 18, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Added colons to more less common psuedo headers
  • Loading branch information
jeff-matthews committed Nov 18, 2019
commit 27d04576d8635a3d06539a4c2e4710f4367ede9f
2 changes: 1 addition & 1 deletion guides/v2.2/b2b/company-structures.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ DELETE /V1/team/:teamId
GET /V1/team/
```

**Company team parameters**
**Company team parameters:**

Name | Description | Format | Requirements
--- | --- | --- | ---
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/b2b/company-users.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ POST /V1/customers/
PUT /V1/customers/:customerId
```

**Company user parameters**
**Company user parameters:**

The following table lists the parameters that can be used to create a company user.

Expand Down
4 changes: 2 additions & 2 deletions guides/v2.2/b2b/credit-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ GET /V1/companyCredits/company/:companyId
GET /V1/companyCredits/
```

**Company credit parameters**
**Company credit parameters:**

Name | Description | Format | Requirements
--- | --- | --- | ---
Expand Down Expand Up @@ -232,7 +232,7 @@ Name | Description | Format | Requirements
`comment` | Describers the operation | String | Optional
`options` | An object that provides additional information for increasing or decreasing the credit balance | Object | Optional

**`options` parameters**
**`options` parameters:**

Name | Description | Format | Requirements
--- | --- | --- | ---
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/b2b/shared-cat-manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ DELETE /V1/sharedCatalog/:sharedCatalogId
GET /V1/sharedCatalog/
```

**Shared catalog parameters**
**Shared catalog parameters:**

Name | Description | Format | Requirements
--- | --- | --- | ---
Expand Down
2 changes: 1 addition & 1 deletion guides/v2.2/cloud/onboarding/onboarding-tasks.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ To quickly onboard your project so you can develop your site for live deployment

Once you have an account, you can use the Magento Project Portal to manage the project for your {{site.data.var.ece}} store. The portal provides a Getting Started guide and an interactive workflow that helps project administrators, business users, and developers with the tasks required to develop, build, test, and launch your site.

**Open the Magento Project Portal**
**Open the Magento Project Portal:**

1. Log in to your Magento account.

Expand Down
46 changes: 23 additions & 23 deletions guides/v2.2/coding-standards/code-standard-demarcation.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ As the first option, you are required to use [HTML](https://glossary.magento.com
- Allows changing look and feel without affecting business functionality, and vice versa.
- Enables frontend teams to clean up old styles quickly and easily when refactoring.

**Acceptable CSS selectors**
**Acceptable CSS selectors:**

```css
.notices-wrapper { ... }
Expand All @@ -162,7 +162,7 @@ a:hover { ... }
nav li._active { ... }
```

**Unacceptable CSS selectors**
**Unacceptable CSS selectors:**

```css
#header { ... }
Expand All @@ -186,7 +186,7 @@ content='Exception: CSS attributes where values must be calculated beyond the cs

%}

**Acceptable [JavaScript](https://glossary.magento.com/javascript) [widget](https://glossary.magento.com/widget) file**
**Acceptable [JavaScript](https://glossary.magento.com/javascript) [widget](https://glossary.magento.com/widget) file:**

```js
...
Expand All @@ -203,7 +203,7 @@ content='Exception: CSS attributes where values must be calculated beyond the cs
...
```

**Unacceptable JavaScript file**
**Unacceptable JavaScript file:**

```js
this.element.on('click', function() {
Expand All @@ -221,13 +221,13 @@ this.element.on('click', function() {
- Enforces clean, strict separation between visual presentation and markup.
- Enables frontend teams quickly and easily clean up old styles.

**Acceptable PHTML template**
**Acceptable PHTML template;**

```php
<div class="no-display"> ... </div>
```

**Unacceptable PHTML template**
**Unacceptable PHTML template:**

```php
<div style="display: none;"> ... </div>
Expand All @@ -241,14 +241,14 @@ this.element.on('click', function() {
- Allows frontend and backend teams to work independently.
- Allows changing business logic without affecting styling and vice versa.

**Acceptable PHTML template**
**Acceptable PHTML template:**

```php
<div data-action="delete" data-mage-init="{myWidget: [option1: 'string']}"></div>
<div data-role="tooltip">More details</div>
```

**Acceptable JavaScript file**
**Acceptable JavaScript file:**

```js
options {
Expand All @@ -264,13 +264,13 @@ $( this.options.tooltip).tooltip(); // Globally for ALL tooltip elements
...
```

**Unacceptable PHTML file**
**Unacceptable PHTML file:**

```php
<div id="my-widget"></div>
```

**Unacceptable JavaScript file**
**Unacceptable JavaScript file:**

```js
$('#my-widget').doSomething();
Expand Down Expand Up @@ -305,14 +305,14 @@ HTML helper class names added in JavaScript REQUIRE underscore symbol ("_") at t

Allows frontend teams to modify markup and themes without affecting business logic.

**Acceptable JavaScript file**
**Acceptable JavaScript file:**

```js
this.element.find('[data-action="edit"]');
this.elements.closest('[data-container]');
```

**Unacceptable JavaScript file**
**Unacceptable JavaScript file:**

```js
this.element.children().children().html('hello world');
Expand All @@ -333,7 +333,7 @@ this.element.parent().find('[data-action="edit"]').data('entity_id');
- Simplifies debugging and reduces number of files to be modified.
- Makes styles more extensible and easier to override when needed.

**Acceptable PHP file**
**Acceptable PHP file:**

```php
...
Expand All @@ -346,7 +346,7 @@ $fieldset->addField('new_category_parent', 'text', array(
...
```

**Unacceptable PHP file**
**Unacceptable PHP file:**

```php
...
Expand All @@ -364,7 +364,7 @@ $fieldset->addField('new_category_parent', 'text', array(
- Reduces long term maintenance by having frontend business logic stored in one place.
- Reduces the number of files to be modified.

**Acceptable PHP file**
**Acceptable PHP file:**

```php
...
Expand All @@ -375,7 +375,7 @@ public function getSelectorOptions()
...
```

**Acceptable PHTML template**
**Acceptable PHTML template:**

```php
...
Expand All @@ -385,7 +385,7 @@ public function getSelectorOptions()

or

**Acceptable PHTML template**
**Acceptable PHTML template:**

```php
...
Expand All @@ -400,7 +400,7 @@ or
...
```

**Unacceptable PHP file**
**Unacceptable PHP file:**

```php
...
Expand All @@ -413,7 +413,7 @@ jQuery('#{$htmlId}-suggest').treeSuggest({$selectorOptions});
...
```

**Unacceptable PHTML template**
**Unacceptable PHTML template:**

```php
<?php echo $this->getAfterElementHtml(); ?>
Expand All @@ -424,7 +424,7 @@ jQuery('#{$htmlId}-suggest').treeSuggest({$selectorOptions});
- Reduces long-term maintenance efforts by having markup stored in one place.
- Reduces the number of files to be modified.

**Acceptable PHP file**
**Acceptable PHP file:**

```php
public function getAttributeName($element)
Expand All @@ -439,7 +439,7 @@ public function getAttributeId($element)
...
```

**Acceptable PHTML template**
**Acceptable PHTML template:**

```php
<span class="attribute-change-checkbox">
Expand All @@ -453,7 +453,7 @@ public function getAttributeId($element)
<!-- jQuery.hide() code can be either located in the widget itself OR can ask PHP Block class whether or not 'weight_and_type_switcher' should be visible. Based on this condition CSS can be applied to hide/show those elements. -->
```

**Unacceptable PHP file**
**Unacceptable PHP file:**

```php
...
Expand All @@ -465,7 +465,7 @@ public function getCheckbox($elementName){
...
```

**Unacceptable PHTML template**
**Unacceptable PHTML template:**

```php
<span class="attribute-change-checkbox">
Expand Down
Loading