Skip to content

Commit 4f6c573

Browse files
Rename "Syllable class reference" to common "Syllable API reference"
1 parent e699b2b commit 4f6c573

3 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ echo $syllable->hyphenateText('Provide your own paragraphs...');
8181

8282
See the [demo.php](demo.php) file for a working example.
8383

84-
`Syllable` class reference
84+
`Syllable` API reference
8585
--------------------------
8686
The following is an incomplete list, containing only the most common methods.
8787
For a complete documentation of all classes, read the generated [PHPDoc](doc).

build/classes/DocumentationManager.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ protected function updateReadme()
148148
}
149149

150150
$readme = file_get_contents($this->readmeFile);
151-
$apiDocumentationStart = strpos($readme, '####', strpos($readme, "`Syllable` class reference\n--------------------------"));
151+
$apiDocumentationStart = strpos($readme, '####', strpos($readme, "`Syllable` API reference\n--------------------------"));
152152
$apiDocumentationEnd = strpos($readme, "Development\n-----------", $apiDocumentationStart);
153153
$apiDocumentationLength = $apiDocumentationEnd - $apiDocumentationStart;
154154
$apiDocumentationOld = '';
@@ -164,7 +164,7 @@ protected function updateReadme()
164164

165165
if ($readmeState < 1) {
166166
if (!($readmeState & 1)) {
167-
$errors[] = 'Missing headlines "`Syllable` class reference" and "Development" to locate API documentation.';
167+
$errors[] = 'Missing headlines "`Syllable` API reference" and "Development" to locate API documentation.';
168168
}
169169
if (isset($errors)) {
170170
throw new Exception(sprintf(

tests/build/DocumentationManagerTest.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ protected function tearDownFixture()
4242
public function delegateSucceeds()
4343
{
4444
$readme = trim('
45-
`Syllable` class reference
45+
`Syllable` API reference
4646
--------------------------
4747
The following is an incomplete list, containing only the most common methods.
4848
For a complete documentation of all classes, read the generated [PHPDoc](doc).
@@ -57,7 +57,7 @@ public function delegateSucceeds()
5757

5858
$expectedOutputRegex = '#The API documentation in the README.md has CHANGED.#';
5959
$expectedReadme = trim('
60-
`Syllable` class reference
60+
`Syllable` API reference
6161
--------------------------
6262
The following is an incomplete list, containing only the most common methods.
6363
For a complete documentation of all classes, read the generated [PHPDoc](doc).
@@ -115,7 +115,7 @@ public function delegateFailsIfReadmeFormatChanges()
115115
$expectedOutput = trim('
116116
Could not update README.md. The format has probably changed:
117117
[
118-
"Missing headlines \"`Syllable` class reference\" and \"Development\" to locate API documentation."
118+
"Missing headlines \"`Syllable` API reference\" and \"Development\" to locate API documentation."
119119
]
120120
Aborting.
121121
')."\n";

0 commit comments

Comments
 (0)