Skip to content

Commit 96db735

Browse files
committed
Update documentation (en and rus)
1 parent 7739675 commit 96db735

2 files changed

Lines changed: 8 additions & 6 deletions

File tree

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## The comparison algorithm
66

7-
`HTML` codes are compared as **browsers** do, to be more exact `html-differ` compares `HTML` codes using the following criteria:
7+
`HTML` codes will be considered to be equivalent if they are equivalent for **browsers**, to be more exact `html-differ` compares `HTML` codes using the following criteria:
88

99
* Two respective lists of attributes are considered to be equivalent even if they are specified in different order.
1010

@@ -238,6 +238,7 @@ Sets predefined options for `BEM` (default: `false`).
238238
* `ignoreHtmlAttrs: ['id', 'for']`
239239
* `compareHtmlAttrsAsJSON: ['data-bem', 'onclick', 'ondblclick']`
240240

241+
**CAUTION!** If `bem` option is set to `true`, other declarations of `ignoreHtmlAttrs` and `compareHtmlAttrsAsJSON` options will be ignored.
241242

242243
###As a program###
243244

README.ru.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Алгоритм сравнения
66

7-
`HTML` коды сравниваются так, как это делают **браузеры**, то есть `html-differ` сравнивает `HTML`-коды по следующим критериям:
7+
`HTML`-коды будут считаться эквивалентыми, если они эквивалентны для **браузеров**, то есть `html-differ` сравнивает `HTML`-коды по следующим критериям:
88

99
* Два соответствующих списка атрибутов считаются эквивалентными, даже если они записаны в разном порядке.
1010

@@ -35,14 +35,14 @@
3535
Например, cледующие два кода будут считаться эквивалентными:
3636

3737
```html
38-
<span class="ab bc cd">Text</span>
38+
<span id="blah" id="ololo">Text</span>
3939
```
4040

4141
```html
42-
<span class=" cd ab bc">Text</span>
42+
<span id="blah">Text</span>
4343
```
4444

45-
* Закрывающие тэги не сравниваются
45+
* Закрывающие тэги не сравниваются.
4646

4747
Например, cледующие два кода будут считаться эквивалентными:
4848

@@ -54,7 +54,7 @@
5454
<span>Text</spane>
5555
```
5656

57-
**ВНИМАНИЕ!** `html-differ` не проверяет валидность `HTML`-кодов, а сравнивает их по выше описанным критериям и задынным опциям (смотрите список возможных опций в [использовании](https://github.com/bem/html-differ/blob/master/README.ru.md#%D0%98%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5)).
57+
**ВНИМАНИЕ!** `html-differ` не проверяет валидность `HTML`-кодов, а сравнивает их по вышеуказанным критериям и задынным опциям (смотрите список возможных опций в [использовании](https://github.com/bem/html-differ/blob/master/README.ru.md#%D0%98%D1%81%D0%BF%D0%BE%D0%BB%D1%8C%D0%B7%D0%BE%D0%B2%D0%B0%D0%BD%D0%B8%D0%B5)).
5858

5959
## Установка
6060

@@ -235,6 +235,7 @@ Text
235235
* `ignoreHtmlAttrs: ['id', 'for']`
236236
* `compareHtmlAttrsAsJSON: ['data-bem', 'onclick', 'ondblclick']`
237237

238+
**ВНИМАНИЕ!** Если указать значение `bem` опции как `true`, то другие объявления опций `ignoreHtmlAttrs` и `compareHtmlAttrsAsJSON` будут проигнорированы.
238239

239240
###Как программа###
240241

0 commit comments

Comments
 (0)