Skip to content

Commit

Permalink
Blueprints: Add resetData step to documentation. (#1658)
Browse files Browse the repository at this point in the history
`resetData` step for blueprints exists and it's the recommended way to
reest data IDs. However, this step doesn't appear in the list of steps
available for blueprints in the docs.

This PR adds that step to the documentation by removing the internal and
private annotations.

## Testing instructions

Run `nx build docs-site` and `npm run dev:docs` locally. Go to
http://localhost:3000/wordpress-playground/blueprints-api/steps#ResetDataStep
and confirm the `resetData` step is there.

cc @juanmaguitar

Fixes #1653
  • Loading branch information
adamziel authored Jul 31, 2024
1 parent cdb69a0 commit 8fae5fb
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions packages/playground/blueprints/src/lib/steps/reset-data.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
import { StepHandler } from '.';

/**
* Deletes WordPress posts and comments and sets the auto increment sequence for the
* posts and comments tables to 0.
*
* @private
* @internal
* @inheritDoc resetData
* @example
*
Expand All @@ -20,6 +15,9 @@ export interface ResetDataStep {
}

/**
* Deletes WordPress posts and comments and sets the auto increment sequence for the
* posts and comments tables to 0.
*
* @param playground Playground client.
*/
export const resetData: StepHandler<ResetDataStep> = async (
Expand Down

0 comments on commit 8fae5fb

Please sign in to comment.