Description
There occasionally are "small" fixes for the generated docmentation. These range from "fixing typos" to "fixing broken links" or "fixing type annotations". These usually do not involve rigorous tests, because this only refers to fixes that do not affect the functionality. A corner case is that of TSDoc fixes that may affect the generated typings. These may warrant some scrutiny, but still are not covered by real specs, but maybe only by a few lines in the Specs/TypeScript/index.ts file.
I'd suggest listing these issues here. Everybody can add comments with things that have to be fixed, and we can try to keep track of the things that have been addressed using GitHub [ ] Task checkboxes.
-
The
Cesium3DTileset.from...functions claim to throw aDeveloperErrorwhen the tileset version is not0.0or1.0. (E.g.fromUrlandfromIonAssetId). Suggested fix: This should include1.1as a valid version number. -
These functions are actually not throwing a
DeveloperError, but aRuntimeError, as of this check. Suggested fix: Considering that the developer does not have influence on whether ~"the data is valid", it should probably be aRuntimeError(and documented accordingly) -
The
...GeometryUpdater#isDynamicproperty documentation contains invalid links. (For example, thePolylineGeometryUpdaterdocumentation, generated fromPolylineGeometryUpdater, but also other updater classes). Suggested fix: It should just omit the part that says* If true, all visualization is delegated to the {@link DynamicGeometryUpdater} * returned by GeometryUpdater#createDynamicUpdater.This is an implementation detail that is not relevant for the reader of the documentation.
-
The
EntityCollection#addfunction claims to throw aDeveloperErrorfor duplicate IDs, but actually throws aRuntimeError. Suggested fix: It should be aDeveloperError. The developer should make sure that there are no duplicate IDs. (In doubt, the developer can trivially check whether an ID is already present) -
The
orientationproperty in the entity constructor options is documented to be of typeProperty, but it can also be aQuaternion. Suggested fix: Change the type to{Property | Quaternion}. Investigate whether the same applies to other properties there.