Skip to content

[doc] usePagination hook docs#1461

Merged
devpatil7 merged 4 commits intodevelopfrom
jimothy/gh-1346_usePagination-hook-docs
Jul 29, 2019
Merged

[doc] usePagination hook docs#1461
devpatil7 merged 4 commits intodevelopfrom
jimothy/gh-1346_usePagination-hook-docs

Conversation

@jcalcaben
Copy link
Contributor

Description

Add JSDoc blocks to the usePagination.js source and create a draft topic for the corresponding reference page.

Related Issue

Closes #1346

Verification Steps

  1. Navigate to the pwa-devdocs directory
  2. Create the reference docs: npm run build-reference-doc-snippets
  3. Verify a usePagination.md file was created in src/_includes/auto-generated/peregrine/src/hooks/ with doc block content from the packages/peregrine/src/hooks/usePagination.js source file.

Screenshots / Screen Captures (if appropriate)

n/a

Checklist:

  • I have updated the documentation accordingly, if necessary.
  • I have added tests to cover my changes, if necessary.

@jcalcaben jcalcaben added pkg:peregrine pkg:pwa-devdocs documentation This pertains to documentation. version: Minor This changeset includes functionality added in a backwards compatible manner. docs documentation labels Jul 24, 2019
@vercel
Copy link

vercel bot commented Jul 24, 2019

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://venia-git-jimothy-gh-1346usepagination-hook-docs.magento-research1.now.sh

@jcalcaben
Copy link
Contributor Author

on hold until #1381 is merged, then I will need to rebase these changes on top of the work done in that PR

@PWAStudioBot
Copy link
Contributor

PWAStudioBot commented Jul 24, 2019

Messages
📖 We are currently working on automating the PR metadata checks. Until that time, you may see failures related to labels/description/linked issues/etc even if you have fixed the problem. Failures will persist until the next push (assuming they are fixed).

Generated by 🚫 dangerJS against 95ca815

@sirugh
Copy link
Contributor

sirugh commented Jul 25, 2019

@jcalcaben we're good to go now -- the other PR was merged.

@jcalcaben jcalcaben force-pushed the jimothy/gh-1346_usePagination-hook-docs branch from 759b869 to e2b327e Compare July 25, 2019 20:50
@vercel vercel bot temporarily deployed to staging July 25, 2019 20:50 Inactive
Copy link
Contributor

@sirugh sirugh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One comment, otherwise 👍

@devpatil7 devpatil7 merged commit 0affb0b into develop Jul 29, 2019
@devpatil7 devpatil7 deleted the jimothy/gh-1346_usePagination-hook-docs branch July 29, 2019 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs documentation documentation This pertains to documentation. pkg:peregrine pkg:pwa-devdocs version: Minor This changeset includes functionality added in a backwards compatible manner.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[doc]: usePagination hook documentation

4 participants