-
-
Notifications
You must be signed in to change notification settings - Fork 149
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[*] Links are unfollowable in generated documentation #362
Comments
So I haven't got a real solution yet, but have found the culprits at least. Basically, the thi.ng/api package defines various function types which are heavily used throughout all umbrella packages. In many cases these umbrella/packages/math/src/step.ts Lines 13 to 24 in 2065c92
Here I've been using the For whatever reason recent Typedoc versions are treating functions using these kind of declarations different than it used to (aka it breaks their docs), so maybe it's worth to also take this issue up with them! The only workaround I can see from my side is to refactor all these code sites and replace them with fully written out argument types. That'd be lot of (needless) work, is also bad for the above point made ([1]) and still wouldn't help in many cases... IMHO what should happen is: Typedoc should have (and likely does have) access to the imported FWIW Here's a "fixed" /**
* GLSL-style smoothStep threshold function.
*
* @param edge - lower threshold
* @param edge2 - upper threshold
* @param x - test value
* @returns 0, if `x < edge1`, 1 if `x > edge2`, else S-curve polynomial interpolation
*/
export const smoothStep = (edge: number, edge2: number, x: number) => {
x = clamp01((x - edge) / (edge2 - edge));
return (3 - 2 * x) * x * x;
}; Produces: |
Fascinating. Thanks for the detailed explanation. Did you want to raise an issue in https://github.com/TypeStrong/typedoc to see if they have any thoughts? |
Yeah, possibly - still want to do more testing first and see if there're any other cases, which might be related. But have to warn you already, it will take me a while and I don't know much more about Typedoc than you do yourself... so if you do have bandwidth for exploring this further or submitting an issue there, pls be my guest! :) |
Just putting this here as reference, should I (or we) ever want to go forward with a custom doc gen. The |
Recent changes to the generated documentation have made links unfollowable for certain modules. For example, see: https://docs.thi.ng/umbrella/math/functions/smoothStep.html
This would normally not be a huge issue, but combined with the fact that the generated documentation also does not include the actual parameter names, I rely on this source link to find out exactly how I am supposed to be using various functions.
Ideally, the documentation would include both the correct parameter names, as well functional links to the source code.
The text was updated successfully, but these errors were encountered: