Skip to content

Commit 365f9f1

Browse files
committed
Compact Function List by Name Document
The entries in the "function list by name" document are very long, and almost all of them require horizontal scrolling, which is not very convenient for the end-user. This PR creates a "function list by name compact" document, in which `CATEGORY_` is stripped from all the category names and `PhpOffice\PhpSpreadsheet\Calculation\` is stripped from all the functions. I believe this eliminates the need to scroll horizontally within the document. I waffled on whether this should replace the existing document, or whether it should be an additional document. I decided there was probably some merit in keeping the old, and hardly any down-side, so, at least for now, we will generate both documents, and they will link to each other. No changes to source code.
1 parent 6b2767c commit 365f9f1

File tree

6 files changed

+721
-8
lines changed

6 files changed

+721
-8
lines changed

bin/generate-document.php

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,20 @@
1111

1212
file_put_contents(
1313
__DIR__ . '/../docs/references/function-list-by-category.md',
14-
DocumentGenerator::generateFunctionListByCategory($phpSpreadsheetFunctions)
14+
DocumentGenerator::generateFunctionListByCategory(
15+
$phpSpreadsheetFunctions
16+
)
1517
);
1618
file_put_contents(
1719
__DIR__ . '/../docs/references/function-list-by-name.md',
18-
DocumentGenerator::generateFunctionListByName($phpSpreadsheetFunctions)
20+
DocumentGenerator::generateFunctionListByName(
21+
$phpSpreadsheetFunctions
22+
)
23+
);
24+
file_put_contents(
25+
__DIR__ . '/../docs/references/function-list-by-name-compact.md',
26+
DocumentGenerator::generateFunctionListByName(
27+
$phpSpreadsheetFunctions,
28+
true
29+
)
1930
);

0 commit comments

Comments
 (0)