Skip to content

Commit

Permalink
Remove the JSDocs "External: Promise"-page, since Promises are now …
Browse files Browse the repository at this point in the history
…a standard feature

The "External: Promise"-page in the JSDocs pre-dates the introduction of `Promise`s, as a generally available standard JS feature, by a number of years. Hence it now longer seems necessary, as far as I can tell, to include this "special" page in the documentation.

Also, while unrelated to the rest of the patch, updates the `test/`-folder description in the documentation.
  • Loading branch information
Snuffleupagus authored and pull[bot] committed Jul 1, 2023
1 parent 84ca2de commit b97d6d0
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 27 deletions.
2 changes: 1 addition & 1 deletion docs/contents/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Note that we only mention the most relevant files and folders.
│   ├── interfaces.js - interface definitions for the core/display layers
│   ├── pdf.*.js - wrapper files for bundling
│   └── worker_loader.js - used for developer builds to load worker files
├── test/ - unit, font and reference tests
├── test/ - unit, font, reference, and integration tests
├── web/ - viewer layer
├── LICENSE
├── README.md
Expand Down
2 changes: 1 addition & 1 deletion gulpfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -1373,7 +1373,7 @@ gulp.task("jsdoc", function (done) {
console.log();
console.log("### Generating documentation (JSDoc)");

const JSDOC_FILES = ["src/doc_helper.js", "src/display/api.js"];
const JSDOC_FILES = ["src/display/api.js"];

rimraf(JSDOC_BUILD_DIR, function () {
mkdirp(JSDOC_BUILD_DIR).then(function () {
Expand Down
25 changes: 0 additions & 25 deletions src/doc_helper.js

This file was deleted.

0 comments on commit b97d6d0

Please sign in to comment.