Collect typing errors in API documentation and source code

SAYEOR · April 30, 2025, 9:03am

Hi @Gabby_Getz , I have discovered many typing errors in the API documentation and source code. I believe there must be more than these, and there are many more potential errors.

Therefore, if these typing errors are fixed by pulling requests, there will be many similar pull requests.

I wonder if a topic could be opened in the community or in Github Issues to collect these errors, and then the official team would fix them uniformly on a regular basis.

SAYEOR · April 30, 2025, 9:08am

for example: L109

github.com/CesiumGS/cesium

packages/engine/Source/Scene/Model/UniformType.js

b66176378


      
           */
          MAT2: "mat2",
          /**
           * A 3x3 matrix of floating point values.
           *
           * @type {string}
           * @constant
           */
          MAT3: "mat3",
          /**
           * A 3x3 matrix of floating point values.
           *
           * @type {string}
           * @constant
           */
          MAT4: "mat4",
          /**
           * A 2D sampled texture.
           * @type {string}
           * @constant
           */

Marco13 · April 30, 2025, 5:36pm

Interestingly, there are update the UniformType : mat3 by HapDragon · Pull Request #11235 · CesiumGS/cesium · GitHub (two years old) and Fix 12524 VaryingType.MAT3: "mat2" significant typo by Hiwen · Pull Request #12526 · CesiumGS/cesium · GitHub (one month old) which are somehow related, and where the latter fixed this exact error, but only for VaryingType (and not for UniformType).

In any case: There is an issue where I’m collecting thse “Ongoing documentation fixes”. (It’s sometimes hard to draw the line, between something that is purely a documentation fix, and something that may affect e.g. the TypeScript typings).

But I just added the one that you brought up at Ongoing documentation fixes · Issue #11749 · CesiumGS/cesium · GitHub

Topic		Replies	Views
Integrating Cesium and Angular CesiumJS	19	215	October 25, 2018
Cesium type definitions for TypeScript CesiumJS	4	1724	August 29, 2023
API reference web page General	3	363	October 27, 2020
API Documentation for Cesium for Unity Cesium for Unity	9	840	December 4, 2023
Proposed updates to issue labels in Cesium's GitHub repo CesiumJS	0	162	December 15, 2016

Collect typing errors in API documentation and source code

Related topics