Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
akudev committed Apr 29, 2024
1 parent 60c8025 commit b42ab27
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 10 deletions.
2 changes: 1 addition & 1 deletion docs/why.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ There are two elements to this topic

SAPUI5 has a large in depth API Reference:

- https://sapui5.hana.ondemand.com/#/api
- https://ui5.sap.com/#/api

However there exists no validation between an end user's source code and the content of the API Reference.
In essence the API Reference is meant **only** for human consumption. Once the API Reference is available
Expand Down
7 changes: 1 addition & 6 deletions packages/dts-generator/src/checkDtslint/check-dtslint.ts
Original file line number Diff line number Diff line change
Expand Up @@ -466,12 +466,7 @@ function getErrorDetails(lintErrorText: string) {
throw new Error(`
Internal error: The string parsing of the dtslint output found no errors although the output contained the term 'error' (${errorStringsFound} times).
This is a hint that dtslint either encountered a general error (details below) or might have been updated and changed its format, so the parsing needs to be adapted.
As dtslint version "latest" is being used, this could suddenly happen for ALL lint/voter runs without any related change in UI5 code. When this situation is encountered in a UI5 CI voter run,
it might be desirable to quickly disable this check. This can be done by adding the entry
{
"status": "ignore"
}
to the list in "dtslint-ignore-list.json" in the "src/dist/docbuilder-maven-plugin/src/main/resources/com/sap/ui5/tools/build/maven/dtsgen/ui5-dts-generator" in sapui5.runtime.
As dtslint version "latest" is being used, this could suddenly happen for ALL lint/voter runs without any related change in UI5 code.
The actual error message was:
${lines.join("\n")}`);
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,7 @@ async function downloadLibs(libs, version, outDir) {
emptyDir(outDir);

// CDN libraries (example URL):
// https://sapui5-sapui5.dispatcher.us1.hana.ondemand.com/test-resources/sap/m/designtime/api.json
// Older versions:
// https://sapui5.hana.ondemand.com/1.71.14/test-resources/sap/m/designtime/api.json
// https://sdk.openui5.org/${version}/test-resources/sap/m/designtime/api.json
const baseUrl = `https://sdk.openui5.org/${version}/test-resources/`;
const nameToFile = zipObject(
libs,
Expand Down

0 comments on commit b42ab27

Please sign in to comment.