Merge pull request #111 from i-akhmadullin/readme

Fix minor errors and inconsistencies in api readme
gemini-testing · Feb 4, 2015 · e9f084c · e9f084c
2 parents 36ceb6a + 3002b64
commit e9f084c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 8 deletions.
diff --git a/doc/programmatic-api.md b/doc/programmatic-api.md
@@ -62,7 +62,7 @@ Suite objects have the following properties:
   suites.
 * `name` – the name of the suite.
 * `children` – array of subsuites of the current suite.
-* `state` – array of the `State` objects, defined in a suite.
+* `states` – array of the `State` objects, defined in a suite.
 
 ### State
 
@@ -133,8 +133,8 @@ Rejects promise if critical error occurred.
 
 * `gemini.getScreenshotPath(suite, stateName, browserId)` – returns path to the reference screenshot
 of the specified state for specified browser.
-* `buildDiff(referencePath, currentPath, diffPath)` – creates a diff image between `referencePath` and
+* `gemini.buildDiff(referencePath, currentPath, diffPath)` – creates a diff image between `referencePath` and
 `currentPath` and stores the result at `diffPath`.
-* `getBrowserCapabilites(browserId)` – returns WebDriver capabilities for specified `browserId`.
-* `browserIds` – list of all browser identificators to use for tests.
+* `gemini.getBrowserCapabilites(browserId)` – returns WebDriver capabilities for specified `browserId`.
+* `gemini.browserIds` – list of all browser identificators to use for tests.
 
diff --git a/doc/programmatic-api.ru.md b/doc/programmatic-api.ru.md
@@ -55,7 +55,7 @@ gemini.readTests()
 * `id` – уникальный идентификатор набора. Генерируется автоматически про загрузке набора.
 * `name` – название набора.
 * `children` – массив дочерних наборов.
-* `state` – массив `State`-объектов, определенных в наборе.
+* `states` – массив `State`-объектов, определенных в наборе.
 
 ### Состояние (State-объект)
 
@@ -109,8 +109,8 @@ state.shouldSkip({browserName: 'firefox', version: '25.0'});
 ## Утилиты
 
 * `gemini.getScreenshotPath(suite, stateName, browserId)` – возвращает путь к эталонному изображению указанного состояния, для указанного браузера.
-* `buildDiff(referencePath, currentPath, diffPath)` – создаёт  diff-изображение между файлами, указанными в `referencePath` и
+* `gemini.buildDiff(referencePath, currentPath, diffPath)` – создаёт  diff-изображение между файлами, указанными в `referencePath` и
 `currentPath`, и сохраняет результат по пути `diffPath`.
-* `getBrowserCapabilites(browserId)` – возвращает свойства WebDriver для указанного `browserId`.
-* `browserIds` – возвращает список идентификаторов всех браузеров, используемых для тестов.
+* `gemini.getBrowserCapabilites(browserId)` – возвращает свойства WebDriver для указанного `browserId`.
+* `gemini.browserIds` – возвращает список идентификаторов всех браузеров, используемых для тестов.