Skip to content

Commit 928cfdb

Browse files
committed
Documentation fixes
1 parent 501ae88 commit 928cfdb

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

src/components/result/GenericResultView.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ export interface GenericResultViewProps {
5656
landingPageLocationField?: string
5757

5858
/**
59-
* The elastic field where the PID of the current FDO will be read from. Can be omitted if you don't have a PID
59+
* The elastic field where the PID of the current result will be read from. Can be omitted if you don't have a PID
6060
*/
6161
pidField?: string
6262

6363
/**
64-
* The elastic field where the unique identifier of the child item(s) of the current FDO will be read from. Should be an array of PIDs or otherwise unique identifiers. Will be displayed in a related items graph.
64+
* The elastic field where the unique identifier of the child item(s) of the current result will be read from. Should be an array of PIDs or otherwise unique identifiers. Will be displayed in a related items graph.
6565
*/
6666
childItemPidField?: string
6767

@@ -74,17 +74,17 @@ export interface GenericResultViewProps {
7474
relatedItemsPrefetchOptions?: { searchFields?: Record<string, SearchFieldConfiguration> }
7575

7676
/**
77-
* The elastic field where the unique identifier of the parent item(s) of the current FDO will be read from. Should be an array of PIDs or otherwise unique identifiers. Will be displayed in a related items graph.
77+
* The elastic field where the unique identifier of the parent item(s) of the current result will be read from. Should be an array of PIDs or otherwise unique identifiers. Will be displayed in a related items graph.
7878
*/
7979
parentItemPidField?: string
8080

8181
/**
82-
* The elastic field where the creation date of the FDO will be read from. Will be parsed as an ISO Date.
82+
* The elastic field where the creation date of the result will be read from. Will be parsed as an ISO Date.
8383
*/
8484
creationDateField?: string
8585

8686
/**
87-
* The elastic field where the edited date of the FDO will be read from. Will be parsed as an ISO Date.
87+
* The elastic field where the edited date of the result will be read from. Will be parsed as an ISO Date.
8888
*/
8989
editedDateField?: string
9090

src/stories/0 Getting Started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,8 @@ export default function Home() {
7474
}
7575
}, []) // Make sure to add all non-static dependencies here! E.g. access code
7676
77-
// To display our results we have to define a result view. Since every FDOs can look very different, the different
78-
// field names have to be defined here. You can also define your own component for rendering results.
77+
// To display our results we have to define a result view. The
78+
// field names of your elastic index have to be referenced here. You can also define your own component for rendering results.
7979
const resultView = useCallback((props: ResultViewProps) => {
8080
// GenericResultView is a configurable fallback component for displaying simple results
8181
return (

0 commit comments

Comments
 (0)