Skip to content

Commit

Permalink
Fix broken link docs warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
leordev committed Feb 12, 2024
1 parent 299bcb0 commit 74fb006
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions packages/api/src/web5.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,16 +26,16 @@ export type TechPreviewOptions = {
*/
export type Web5ConnectOptions = {
/**
* Provide a {@link @web5/agent#Web5Agent} implementation. Defaults to creating a local
* {@link @web5/user-agent#Web5UserAgent} if one isn't provided
* Provide a {@link Web5Agent} implementation. Defaults to creating a local
* {@link Web5UserAgent} if one isn't provided
**/
agent?: Web5Agent;

/**
* Provide an instance of a {@link @web5/agent#AppDataStore} implementation. Defaults to
* Provide an instance of a {@link AppDataStore} implementation. Defaults to
* a LevelDB-backed store with an insecure, static unlock passphrase if one
* isn't provided. To allow the app user to enter a secure passphrase of
* their choosing, provide an initialized {@link @web5/agent#AppDataStore} instance.
* their choosing, provide an initialized {@link AppDataStore} instance.
**/
appData?: AppDataStore;

Expand Down Expand Up @@ -98,7 +98,7 @@ export class Web5 {
}

/**
* Connects to a {@link @web5/agent#Web5Agent}. Defaults to creating a local {@link @web5/user-agent#Web5UserAgent}
* Connects to a {@link Web5Agent}. Defaults to creating a local {@link Web5UserAgent}
* if one isn't provided.
*
* @param options - optional overrides
Expand Down
4 changes: 2 additions & 2 deletions packages/crypto-aws-kms/src/ecdsa.ts
Original file line number Diff line number Diff line change
Expand Up @@ -162,8 +162,8 @@ export class EcdsaAlgorithm implements
*
* Note: The signature returned is normalized to low-S to prevent signature malleability. This
* ensures that the signature can be verified by other libraries that enforce strict verification.
* More information on signature malleability can be found
* {@link @web5/crypto#Secp256k1.adjustSignatureToLowS | here}.
* More information on signature malleability can be found on
* {@link Secp256k1.adjustSignatureToLowS | here}.
*
* @example
* ```ts
Expand Down
2 changes: 1 addition & 1 deletion packages/dids/src/methods/did-dht.ts
Original file line number Diff line number Diff line change
Expand Up @@ -609,7 +609,7 @@ export class DidDht extends DidMethod {
* ```
*
* @param params - The parameters for the import operation.
* @param params.portableDid - The PortableDid object to import.
* @param params.portableDid - The {@link PortableDid} object to import.
* @param params.keyManager - Optionally specify an external Key Management System (KMS) used to
* generate keys and sign data. If not given, a new
* {@link LocalKeyManager} instance will be created and
Expand Down

0 comments on commit 74fb006

Please sign in to comment.