Skip to content

Commit 011897f

Browse files
authored
chore(docs): Revising scope of wrapPageElement() and wrapRootElement() (#35057)
1 parent 8947b18 commit 011897f

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

packages/gatsby/src/utils/api-browser-docs.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ export const shouldUpdateScroll = true
115115
export const registerServiceWorker = true
116116

117117
/**
118-
* Allow a plugin to wrap the page element.
118+
* Can be used to wrap each page element.
119119
*
120120
* This is useful for setting wrapper components around pages that won't get
121121
* unmounted on page changes. For setting Provider components, use [wrapRootElement](#wrapRootElement).
@@ -142,7 +142,7 @@ export const registerServiceWorker = true
142142
export const wrapPageElement = true
143143

144144
/**
145-
* Allow a plugin to wrap the root element.
145+
* Can be used to the wrap the root element.
146146
*
147147
* This is useful to set up any Provider components that will wrap your application.
148148
* For setting persistent UI elements around pages use [wrapPageElement](#wrapPageElement).

0 commit comments

Comments
 (0)