Skip to content

Commit 2ade90f

Browse files
0xwitty0xwitty
authored
chore: fix bad spelling (#3637)
1 parent fabd8e2 commit 2ade90f

1 file changed

Lines changed: 29 additions & 29 deletions

File tree

‎scripts/render-api-docs.ts‎

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ const PUBLIC_APIS: PublicApis = {
2424
content = removeAuthor(content);
2525
content = formatHeadings(content);
2626
content = fixGithubLinks(content, "store");
27-
content = fixInheritence(content);
27+
content = fixinheritance(content);
2828
content = addSampleCodeFunction(content, "registerTable", "/store/tables#manually-register-a-table");
2929
content = addSampleCodeFunction(content, "registerStoreHook", "/store/store-hooks");
3030
content = addSampleCodeFunction(content, "setStoreAddress", "/store/table-libraries#storeswitch");
@@ -47,7 +47,7 @@ const PUBLIC_APIS: PublicApis = {
4747
content = removeAuthor(content);
4848
content = formatHeadings(content);
4949
content = fixGithubLinks(content, "store");
50-
content = fixInheritence(content);
50+
content = fixinheritance(content);
5151
content = addSampleCodeFunction(content, "registerTable", "/store/tables#manually-register-a-table");
5252
content = addSampleCodeFunction(content, "registerStoreHook", "/store/store-hooks");
5353

@@ -64,7 +64,7 @@ const PUBLIC_APIS: PublicApis = {
6464
content = removeAuthor(content);
6565
content = formatHeadings(content);
6666
content = fixGithubLinks(content, "store");
67-
content = fixInheritence(content);
67+
content = fixinheritance(content);
6868
content = addSampleCodeContract(content, "IStoreHook", "/store/store-hooks#store-hook-contract");
6969

7070
return content;
@@ -93,7 +93,7 @@ const PUBLIC_APIS: PublicApis = {
9393
content = removeAuthor(content);
9494
content = formatHeadings(content);
9595
content = fixGithubLinks(content, "store");
96-
content = fixInheritence(content);
96+
content = fixinheritance(content);
9797
content = addSampleCodeFunction(content, "encode", "/world/namespaces-access-control#modifying-access-control");
9898

9999
return content
@@ -114,7 +114,7 @@ const PUBLIC_APIS: PublicApis = {
114114
content = removeAuthor(content);
115115
content = formatHeadings(content);
116116
content = fixGithubLinks(content, "world");
117-
content = fixInheritence(content);
117+
content = fixinheritance(content);
118118

119119
return content;
120120
},
@@ -125,7 +125,7 @@ const PUBLIC_APIS: PublicApis = {
125125
content = removeAuthor(content);
126126
content = formatHeadings(content);
127127
content = fixGithubLinks(content, "world");
128-
content = fixInheritence(content);
128+
content = fixinheritance(content);
129129
return content;
130130
},
131131
},
@@ -135,7 +135,7 @@ const PUBLIC_APIS: PublicApis = {
135135
content = removeAuthor(content);
136136
content = formatHeadings(content);
137137
content = fixGithubLinks(content, "world");
138-
content = fixInheritence(content);
138+
content = fixinheritance(content);
139139
return content;
140140
},
141141
},
@@ -145,7 +145,7 @@ const PUBLIC_APIS: PublicApis = {
145145
content = removeAuthor(content);
146146
content = formatHeadings(content);
147147
content = fixGithubLinks(content, "world");
148-
content = fixInheritence(content);
148+
content = fixinheritance(content);
149149
content = addSampleCodeContract(content, "IDelegationControl", "/world/account-delegation");
150150

151151
return content;
@@ -157,7 +157,7 @@ const PUBLIC_APIS: PublicApis = {
157157
content = removeAuthor(content);
158158
content = formatHeadings(content);
159159
content = fixGithubLinks(content, "world");
160-
content = fixInheritence(content);
160+
content = fixinheritance(content);
161161
return (
162162
content
163163
// fix bad placeholder
@@ -174,7 +174,7 @@ const PUBLIC_APIS: PublicApis = {
174174
content = removeAuthor(content);
175175
content = formatHeadings(content);
176176
content = fixGithubLinks(content, "world");
177-
content = fixInheritence(content);
177+
content = fixinheritance(content);
178178
return content;
179179
},
180180
},
@@ -184,7 +184,7 @@ const PUBLIC_APIS: PublicApis = {
184184
content = removeAuthor(content);
185185
content = formatHeadings(content);
186186
content = fixGithubLinks(content, "world");
187-
content = fixInheritence(content);
187+
content = fixinheritance(content);
188188

189189
return content;
190190
},
@@ -195,7 +195,7 @@ const PUBLIC_APIS: PublicApis = {
195195
content = removeAuthor(content);
196196
content = formatHeadings(content);
197197
content = fixGithubLinks(content, "world");
198-
content = fixInheritence(content);
198+
content = fixinheritance(content);
199199
return content;
200200
},
201201
},
@@ -209,7 +209,7 @@ const PUBLIC_APIS: PublicApis = {
209209
content = removeAuthor(content);
210210
content = formatHeadings(content);
211211
content = fixGithubLinks(content, "world");
212-
content = fixInheritence(content);
212+
content = fixinheritance(content);
213213
return content.replace("Constants", "systemHookTypes.sol constants");
214214
},
215215
},
@@ -219,7 +219,7 @@ const PUBLIC_APIS: PublicApis = {
219219
content = removeAuthor(content);
220220
content = formatHeadings(content);
221221
content = fixGithubLinks(content, "world");
222-
content = fixInheritence(content);
222+
content = fixinheritance(content);
223223
content = addSampleCodeFunction(content, "call", "/world/systems#using-call");
224224

225225
return content;
@@ -231,7 +231,7 @@ const PUBLIC_APIS: PublicApis = {
231231
content = removeAuthor(content);
232232
content = formatHeadings(content);
233233
content = fixGithubLinks(content, "world");
234-
content = fixInheritence(content);
234+
content = fixinheritance(content);
235235
return content;
236236
},
237237
},
@@ -241,7 +241,7 @@ const PUBLIC_APIS: PublicApis = {
241241
content = removeAuthor(content);
242242
content = formatHeadings(content);
243243
content = fixGithubLinks(content, "world");
244-
content = fixInheritence(content);
244+
content = fixinheritance(content);
245245
content = addSampleCodeFunction(content, "call", "/world/systems#using-call");
246246

247247
return content
@@ -267,7 +267,7 @@ const PUBLIC_APIS: PublicApis = {
267267
content = removeAuthor(content);
268268
content = formatHeadings(content);
269269
content = fixGithubLinks(content, "world");
270-
content = fixInheritence(content);
270+
content = fixinheritance(content);
271271
content = addSampleCodeFunction(
272272
content,
273273
"grantAccess",
@@ -304,7 +304,7 @@ const PUBLIC_APIS: PublicApis = {
304304
content = removeAuthor(content);
305305
content = formatHeadings(content);
306306
content = fixGithubLinks(content, "world");
307-
content = fixInheritence(content);
307+
content = fixinheritance(content);
308308
return content.replace("Constants", "WorldContext.sol constants");
309309
},
310310
},
@@ -314,7 +314,7 @@ const PUBLIC_APIS: PublicApis = {
314314
content = removeAuthor(content);
315315
content = formatHeadings(content);
316316
content = fixGithubLinks(content, "world");
317-
content = fixInheritence(content);
317+
content = fixinheritance(content);
318318
return content;
319319
},
320320
},
@@ -324,7 +324,7 @@ const PUBLIC_APIS: PublicApis = {
324324
content = removeAuthor(content);
325325
content = formatHeadings(content);
326326
content = fixGithubLinks(content, "world");
327-
content = fixInheritence(content);
327+
content = fixinheritance(content);
328328
content = addSampleCodeFunction(content, "encodeNamespace", "/world/systems#registering-systems");
329329

330330
return content
@@ -343,7 +343,7 @@ const PUBLIC_APIS: PublicApis = {
343343
content = removeAuthor(content);
344344
content = formatHeadings(content);
345345
content = fixGithubLinks(content, "world");
346-
content = fixInheritence(content);
346+
content = fixinheritance(content);
347347
return content.replace("Constants", "constants.sol").replace("Constants", "version.sol constants");
348348
},
349349
},
@@ -359,7 +359,7 @@ const PUBLIC_APIS: PublicApis = {
359359
content = removeAuthor(content);
360360
content = formatHeadings(content);
361361
content = fixGithubLinks(content, "world");
362-
content = fixInheritence(content);
362+
content = fixinheritance(content);
363363
return content.replace("Constants", "constants.sol");
364364
},
365365
},
@@ -376,7 +376,7 @@ const PUBLIC_APIS: PublicApis = {
376376
content = removeAuthor(content);
377377
content = formatHeadings(content);
378378
content = fixGithubLinks(content, "world");
379-
content = fixInheritence(content);
379+
content = fixinheritance(content);
380380
content = addSampleCodeFunction(content, "registerNamespace", "/world/systems#registering-systems");
381381
content = addSampleCodeFunction(content, "registerSystem", "/world/systems#registering-systems");
382382
content = addSampleCodeFunction(content, "registerFunctionSelector", "/world/function-selectors");
@@ -403,13 +403,13 @@ function fixGithubLinks(content: string, packageName: string) {
403403
return content.replace(pattern, replacement);
404404
}
405405

406-
/* Fix inheritence links.
406+
/* Fix inheritance links.
407407
* Creating the pattern a new for every call is inefficient, but I'm optimizing for programmer time
408408
*/
409-
function fixInheritence(content: string) {
409+
function fixinheritance(content: string) {
410410
let newContent = content;
411-
for (let i = 0; i < inheritence.length; i++) {
412-
const item = inheritence[i];
411+
for (let i = 0; i < inheritance.length; i++) {
412+
const item = inheritance[i];
413413
const pattern = `\\[${item.contract}\\]\\([/a-zA-Z0-9.#]+\\)`;
414414
newContent = newContent.replaceAll(new RegExp(pattern, "g"), `[${item.contract}](${item.link})`);
415415
}
@@ -421,8 +421,8 @@ function removeAuthor(content: string) {
421421
return content.replace(/\*\*Author:\*\*\n[^\n]+\n/g, "");
422422
}
423423

424-
// The inheritence links that need to be fixed
425-
const inheritence = [
424+
// The inheritance links that need to be fixed
425+
const inheritance = [
426426
{ contract: "StoreRead", link: "/store/reference/store-core#storeread" },
427427
{ contract: "StoreData", link: "/store/reference/store-core#storedata" },
428428
{ contract: "StoreKernel", link: "/store/reference/store-core#storekernel" },

0 commit comments

Comments
 (0)