Fix incorrect spring stiffness default in docs#3672
Fix incorrect spring stiffness default in docs#3672Dakshh-Agarwal wants to merge 1 commit intomotiondivision:mainfrom
Conversation
|
Opened a PR to fix this by adding explicit TSDoc defaults for the spring options metadata. |
Greptile SummaryThis PR adds explicit TSDoc
Confidence Score: 5/5Safe to merge — purely additive TSDoc annotation change with no runtime impact. No logic changes, no API surface changes, and the documented default values have been verified against the actual springDefaults implementation. Zero risk of regression. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[SpringOptions interface\npackages/motion-dom/src/animation/types.ts] -->|TSDoc @default tags| B[stiffness: 100]
A -->|TSDoc @default tags| C[damping: 10]
A -->|TSDoc @default tags| D[mass: 1]
E[springDefaults\npackages/motion-dom/src/animation/generators/spring.ts] -->|runtime default| B
E -->|runtime default| C
E -->|runtime default| D
B & C & D -->|consumed by| F[Doc generator]
F -->|renders correct defaults| G[Public docs site]
Reviews (1): Last reviewed commit: "Fix incorrect spring default values in d..." | Re-trigger Greptile |
Summary
Fixes the incorrect default value shown for
stiffnessin the docs.Changes made
@defaultvalues for spring options inSpringOptionsstiffnessto100dampingas10andmassas1Notes
The docs appear to be generated from source metadata, and the runtime implementation already uses
stiffness: 100inspringDefaults.Issue
Closes #3664