Merge pull request #5517 from ValentinnDimitroff/code-examples-fixes

Editing code examples errors and typos
marmelab · Nov 12, 2020 · 1e2e575 · 1e2e575
2 parents cf41914 + 03e78cd
commit 1e2e575
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 deletions.
diff --git a/packages/ra-core/src/controller/useListContext.ts b/packages/ra-core/src/controller/useListContext.ts
@@ -44,7 +44,7 @@ import { Record } from '../types';
  * import { useListContext } from 'react-admin';
  *
  * const MyList = () => {
- *     const { data, id, loaded } = useListContext();
+ *     const { data, ids, loaded } = useListContext();
  *     if (!loaded) {
  *         return <>Loading...</>;
  *     }

diff --git a/packages/ra-ui-materialui/src/field/ReferenceField.tsx b/packages/ra-ui-materialui/src/field/ReferenceField.tsx
@@ -55,7 +55,7 @@ import { ClassesOverride } from '../types';
  * as arguments and return a string
  *
  * @example
- * <ReferenceField label="User" source="userId" reference="users" link={(reference, record) => "/path/to/${reference}/${record}"}>
+ * <ReferenceField label="User" source="userId" reference="users" link={(record, reference) => "/path/to/${reference}/${record}"}>
  *     <TextField source="name" />
  * </ReferenceField>
  *

diff --git a/packages/ra-ui-materialui/src/list/SimpleList.tsx b/packages/ra-ui-materialui/src/list/SimpleList.tsx
@@ -46,6 +46,7 @@ const useStyles = makeStyles(
  * - rightAvatar: same
  * - rightIcon: same
  * - linkType: 'edit' or 'show', or a function returning 'edit' or 'show' based on the record
+ * - rowStyle: function returning a style object based on (record, index)
  *
  * @example // Display all posts as a List
  *