Skip to content

Commit

Permalink
chore: import editorial review
Browse files Browse the repository at this point in the history
  • Loading branch information
Caele committed Mar 31, 2021
1 parent bb6f647 commit 092d324
Show file tree
Hide file tree
Showing 8 changed files with 24 additions and 24 deletions.
2 changes: 1 addition & 1 deletion apis/conversion/src/export-format.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/**
* Used for exporting and importing properties between backend models. An object that exports to
* ExportFormat should put dimensions and measures inside one data group. If an object has two hypercubes
* ExportFormat should put dimensions and measures inside one data group. If an object has two hypercubes,
* each of the cubes should export dimensions and measures in two separate data groups.
* An object that imports from this structure is responsible for putting the existing properties where they should be
* in the new model.
Expand Down
4 changes: 2 additions & 2 deletions apis/conversion/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ export const convertTo = async ({ halo, model, cellRef, newType }) => {
* @alias Conversion
* @experimental
* @since 1.1.0
* @description Provides conversion functionality to extensions
* @description Provides conversion functionality to extensions.
* @example
* import { conversion } from '@nebula.js/stardust';
*
Expand All @@ -108,7 +108,7 @@ const conversion = {
* @type {hyperCubeConversion}
* @experimental
* @since 1.1.0
* @description Provides conversion functionality for extensions with hyperCubes
* @description Provides conversion functionality to extensions with hyperCubes.
*/
hypercube,
};
Expand Down
8 changes: 4 additions & 4 deletions apis/locale/src/translator.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,10 @@ export default function translator({ initial = 'en-US', fallback = 'en-US' } = {
});
},
/**
* Translates a string for current locale
* @param {string} str - Id of the registered string
* @param {Array<string>=} args - Values passed down for string interpolation
* @returns {string} The translated string
* Translates a string for current locale.
* @param {string} str - ID of the registered string.
* @param {Array<string>=} args - Values passed down for string interpolation.
* @returns {string} The translated string.
*/
get(str, args) {
let v;
Expand Down
2 changes: 1 addition & 1 deletion apis/nucleus/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -430,7 +430,7 @@ function nuked(configuration = {}) {
/**
* @interface ThemeInfo
* @property {string} id Theme identifier
* @property {function(): Promise<ThemeJSON>} load A function that should return a Promise that resolve to a raw JSON theme
* @property {function(): Promise<ThemeJSON>} load A function that should return a Promise that resolves to a raw JSON theme.
*/

export default nuked(DEFAULT_CONFIG);
8 changes: 4 additions & 4 deletions apis/nucleus/src/viz.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ export default function viz({ model, halo, initialError, onDestroy = async () =>
*/
id: model.id,
/**
* Destroys the visualization and removes if from the the DOM.
* Destroys the visualization and removes it from the the DOM.
* @example
* const viz = await embed(app).render({
* element,
Expand All @@ -67,12 +67,12 @@ export default function viz({ model, halo, initialError, onDestroy = async () =>
unmountCell = noopi;
},
/**
* Converts the visualization to a different registred type
* Converts the visualization to a different registered type
* @experimental
* @since 1.1.0
* @param {string} newType - Which registered type to convert to
* @param {string} newType - Which registered type to convert to.
* @param {boolean=} forceUpdate - Whether to run setProperties or not, defaults to true.
* @returns {Promise<object>} Promise object that resolves to the full property tree of the converted visualizatiom
* @returns {Promise<object>} Promise object that resolves to the full property tree of the converted visualization.
* @example
* const viz = await embed(app).render({
* element,
Expand Down
8 changes: 4 additions & 4 deletions apis/supernova/src/hooks.js
Original file line number Diff line number Diff line change
Expand Up @@ -292,10 +292,10 @@ export function useState(initial) {
*/

/**
* Triggers a callback function when a dependant value changes.
* Triggers a callback function when a dependent value changes.
* @entry
* @param {EffectCallback} effect - The callback.
* @param {Array<any>=} deps - The dependencies which should trigger the callback.
* @param {Array<any>=} deps - The dependencies that should trigger the callback.
* @example
* import { useEffect } from '@nebula.js/stardust';
* // ...
Expand Down Expand Up @@ -336,7 +336,7 @@ function useLayoutEffect(cb, deps) {
}

/**
* Creates a stateful value when a dependant changes.
* Creates a stateful value when a dependent changes.
* @entry
* @template T
* @param {function():T} factory - The factory function.
Expand All @@ -363,7 +363,7 @@ export function useMemo(fn, deps) {
}

/**
* Runs a callback function when a dependant changes.
* Runs a callback function when a dependent changes.
* @entry
* @template P
* @param {function():Promise<P>} factory - The factory function that calls the promise.
Expand Down
10 changes: 5 additions & 5 deletions apis/theme/src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,13 @@ export default function theme() {
},

/**
* Get the value of a style attribute in the theme by searching in the theme's json structure.
* The search starts at the specified base path and continue upwards until the value is found.
* Get the value of a style attribute in the theme by searching in the theme's JSON structure.
* The search starts at the specified base path and continues upwards until the value is found.
* If possible it will get the attribute's value using the given path.
*
* @param {string} basePath - Base path in the theme's json structure to start the search in (specified as a name path separated by dots)
* @param {string} path - Expected path for the attribute (specified as a name path separated by dots)
* @param {string} attribute - Name of the style attribute
* @param {string} basePath - Base path in the theme's JSON structure to start the search in (specified as a name path separated by dots).
* @param {string} path - Expected path for the attribute (specified as a name path separated by dots).
* @param {string} attribute - Name of the style attribute.
* @returns {string} The style value
*
* @example
Expand Down
6 changes: 3 additions & 3 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ const [value, setValue] = useState(() => heavy());
- `effect` <[EffectCallback]> The callback.
- `deps` <[Array]<`any`>> The dependencies which should trigger the callback.

Triggers a callback function when a dependant value changes.
Triggers a callback function when a dependent value changes.

```js
import { useEffect } from '@nebula.js/stardust';
Expand All @@ -186,7 +186,7 @@ useEffect(() => {
- `deps` <[Array]<`any`>> The dependencies.
- `returns:` <`T`> The value returned from the factory function.

Creates a stateful value when a dependant changes.
Creates a stateful value when a dependent changes.

```js
import { useMemo } from '@nebula.js/stardust';
Expand All @@ -202,7 +202,7 @@ const v = useMemo(() => {
- `deps` <[Array]<`any`>> The dependencies.
- `returns:` <[Array]> The resolved value.

Runs a callback function when a dependant changes.
Runs a callback function when a dependent changes.

```js
import { usePromise } from '@nebula.js/stardust';
Expand Down

0 comments on commit 092d324

Please sign in to comment.