update docs

pondersource · Dec 21, 2023 · 9021335 · 9021335
1 parent 7bd8215
commit 9021335
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/docs/solid-typeindex-support.typeindexhelper.getfromtypeindex.md b/docs/solid-typeindex-support.typeindexhelper.getfromtypeindex.md
@@ -17,7 +17,7 @@ static getFromTypeIndex(webId: string, rdfClass: string, fetch: any, isPrivate:
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  webId | string | The user's WebID |
-|  rdfClass | string | The RDF class to retrieve instances for (it has to be a valid URL) |
+|  rdfClass | string | The RDF class to retrieve instances for, as a Valid URL |
 |  fetch | any | Authenticated fetch function |
 |  isPrivate | boolean | Whether the typeIndexe is private or public |
 

diff --git a/docs/solid-typeindex-support.typeindexhelper.md b/docs/solid-typeindex-support.typeindexhelper.md
@@ -17,5 +17,5 @@ export declare class TypeIndexHelper
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [getFromTypeIndex(webId, rdfClass, fetch, isPrivate)](./solid-typeindex-support.typeindexhelper.getfromtypeindex.md) | <code>static</code> | Retrieves all instances of the given RDF class from the user's typeIndexe. |
-|  [registerInTypeIndex(webId, typeRegistrationTitle, rdfClass, fetch, indexUrl, isPrivate)](./solid-typeindex-support.typeindexhelper.registerintypeindex.md) | <code>static</code> | Registers a type registration in the user's typeIndexe. |
+|  [registerInTypeIndex(webId, typeRegistrationTitle, rdfClass, fetch, solidInstanceUrl, isPrivate)](./solid-typeindex-support.typeindexhelper.registerintypeindex.md) | <code>static</code> | Registers a typeRegistration in the user's typeIndexe. |
 
diff --git a/docs/solid-typeindex-support.typeindexhelper.registerintypeindex.md b/docs/solid-typeindex-support.typeindexhelper.registerintypeindex.md
@@ -4,23 +4,23 @@
 
 ## TypeIndexHelper.registerInTypeIndex() method
 
-Registers a type registration in the user's typeIndexe.
+Registers a typeRegistration in the user's typeIndexe.
 
 **Signature:**
 
 ```typescript
-static registerInTypeIndex(webId: string, typeRegistrationTitle: string, rdfClass: string, fetch: any, indexUrl: string, isPrivate: boolean): Promise<SolidDataset>;
+static registerInTypeIndex(webId: string, typeRegistrationTitle: string, rdfClass: string, fetch: any, solidInstanceUrl: string, isPrivate: boolean): Promise<SolidDataset>;
 ```
 
 ## Parameters
 
 |  Parameter | Type | Description |
 |  --- | --- | --- |
 |  webId | string | The WebID of the user |
-|  typeRegistrationTitle | string | The title to use for the type registration |
-|  rdfClass | string | The RDF class that this registration is for (it has to be a valid URL) |
+|  typeRegistrationTitle | string | The title to use for the typeRegistration inside the typeIndex, |
+|  rdfClass | string | The RDF class that this registration is for, as a Valid URL |
 |  fetch | any | The authenticated fetch function |
-|  indexUrl | string | The URL of the index being registered |
+|  solidInstanceUrl | string | The URL of the solid:instance being registered |
 |  isPrivate | boolean | Whether to register in the private or public typeIndexe |
 
 **Returns:**

diff --git a/etc/solid-typeindex-support.api.md b/etc/solid-typeindex-support.api.md
@@ -9,7 +9,7 @@ import { SolidDataset } from '@inrupt/solid-client';
 // @public
 export class TypeIndexHelper {
     static getFromTypeIndex(webId: string, rdfClass: string, fetch: any, isPrivate: boolean): Promise<string[]>;
-    static registerInTypeIndex(webId: string, typeRegistrationTitle: string, rdfClass: string, fetch: any, indexUrl: string, isPrivate: boolean): Promise<SolidDataset>;
+    static registerInTypeIndex(webId: string, typeRegistrationTitle: string, rdfClass: string, fetch: any, solidInstanceUrl: string, isPrivate: boolean): Promise<SolidDataset>;
 }
 
 // (No @packageDocumentation comment for this package)