Skip to content

Commit

Permalink
Docs: Minor refinements.
Browse files Browse the repository at this point in the history
  • Loading branch information
kitschpatrol committed Jan 2, 2024
1 parent cfadfde commit 92954a8
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 10 deletions.
9 changes: 5 additions & 4 deletions src/lib/control/CubicBezier.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -109,10 +109,11 @@ bezier value to an easing function compatible with Svelte's built-in
Usage outside of a `<Pane>` component will implicitly wrap the cubic bezier control in `<Pane
position='inline'>`.
_Note: A memory leak has been observed in situations when the `value` prop is written frequently
from outside the component. See [issue
#18](https://github.com/tweakpane/plugin-essentials/issues/18) on the Plugin Essentials repo for
updates. Consider managing the lifecycle of this component with care until this issue is resolved._
_Note: An issue with unreleased resources has been observed in situations when the `value` prop is
set frequently. A [PR on the Plugin Essentials repo with a
fix](https://github.com/tweakpane/plugin-essentials/pull/21) is currently pending a review and
merge. Consider monitoring the performance of this component in the context of your use case until
this issue is resolved._
@example
```svelte
Expand Down
2 changes: 1 addition & 1 deletion src/lib/control/Point.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@
* */
max?: number;
/**
* A function to customize the point value's formatting (e.g. rounding, etc.).
* A function to customize the point value's string representation (e.g. rounding, etc.).
* @default `undefined` \
* Normal `.toString()` formatting.
* */
Expand Down
2 changes: 1 addition & 1 deletion src/lib/control/Ring.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
* */
unit?: RingUnit;
/**
* When `true`, expand the width of the ring control at the expense of the numerical input
* When `true`, expand the width of the ring control at the expense of the numeric input
* field.
* @default `false`
* */
Expand Down
2 changes: 1 addition & 1 deletion src/lib/control/Slider.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

<!--
@component
A slider component providing fine-grained control over numerical values.
A slider component providing fine-grained control over numeric values.
Wraps Tweakpane's [number bindings](https://tweakpane.github.io/docs/input-bindings/#number).
Expand Down
2 changes: 1 addition & 1 deletion src/lib/control/Wheel.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
*/
amount?: number;
/**
* When `true`, expand the width of the wheel control at the expense of the numerical input
* When `true`, expand the width of the wheel control at the expense of the numeric input
* field.
* @default `false`
* */
Expand Down
2 changes: 1 addition & 1 deletion src/lib/internal/GenericSlider.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
* */
max?: number;
/**
* A function to customize the point value's formatting (e.g. rounding, etc.).
* A function to customize the point value's string representation (e.g. rounding, etc.).
* @default `undefined` \
* Normal `.toString()` formatting.
* */
Expand Down
2 changes: 1 addition & 1 deletion src/lib/internal/InternalMonitorNumber.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@
* */
max?: number;
/**
* A function to customize the number's formatting (e.g. rounding, etc.).
* A function to customize the number's string representation (e.g. rounding, etc.).
* @default `undefined` \
* Normal `.toString()` formatting.
* */
Expand Down

0 comments on commit 92954a8

Please sign in to comment.