Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: incorrect URL references to APIs in JSDoc #119

Merged
merged 1 commit into from
Oct 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package/src/core/create-resolver.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import { dirname, resolve } from "pathe";
*
* @param {string} _base - The location you want to create relative references from. `import.meta.url` is usually what you'll want.
*
* @see https://astro-integration-kit.netlify.app/utilities/create-resolver/
* @see https://astro-integration-kit.netlify.app/core/create-resolver/
*
* @example
* ```ts
Expand Down
2 changes: 1 addition & 1 deletion package/src/core/define-all-hooks-plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export type AllHooksPlugin<TName extends string, TApi extends Record<string, unk
* called dynamically for each hook. This allows plugins to support any hook
* even those added by new versions of astro or hooks added by other integrations.
*
* @see https://astro-integration-kit.netlify.app/utilities/define-plugin/
* @see https://astro-integration-kit.netlify.app/core/define-plugin/
*/
export const defineAllHooksPlugin = <TName extends string, TApi extends Record<string, unknown>>(
plugin: AllHooksPluginDefinition<TName, TApi>
Expand Down
2 changes: 1 addition & 1 deletion package/src/core/define-integration.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ type AstroIntegrationSetupFn<Options extends z.ZodTypeAny, TApi> = (params: {
* @param {import("astro/zod").AnyZodObject} params.optionsSchema - An optional zod schema to handle your integration options
* @param {function} params.setup - This will be called from your `astro:config:setup` call with the user options
*
* @see https://astro-integration-kit.netlify.app/utilities/define-integration/
* @see https://astro-integration-kit.netlify.app/core/define-integration/
*
* @example
* ```ts
Expand Down
2 changes: 1 addition & 1 deletion package/src/core/define-plugin.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import type { Plugin, PluginHooksConstraint } from "./types.js";
* @param {string} plugin.hook - The name of the hook where this plugin should be available
* @param {Function} plugin.implementation - The actual function definition. Refer to docs for usage
*
* @see https://astro-integration-kit.netlify.app/utilities/define-plugin/
* @see https://astro-integration-kit.netlify.app/core/define-plugin/
*
* ```ts
* import { definePlugin } from "../core/define-plugin.js";
Expand Down
2 changes: 1 addition & 1 deletion package/src/core/define-utility.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ export type HookUtility<
*
* @param {string} _hook
*
* @see https://astro-integration-kit.netlify.app/utilities/define-utility/
* @see https://astro-integration-kit.netlify.app/core/define-utility/
*
* @example
* ```ts
Expand Down
Loading