Emphasize importance of promise return on source-plugin docs #9650
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lexishanson
added
the
type: documentation
shannonbux
approved these changes
Nov 2, 2018
| Gatsby when you're done sourcing nodes. Otherwise either Gatsby will continue | ||
| on before you're done sourcing or hang while waiting for you to indicate | ||
| you're finished. | ||
| - Return either a promise or use the callback (3rd parameter) to report back to Gatsby when `sourceNodes` is fully executed. If a promise or callback isn't returned, Gatsby will continue on in the build process, before nodes are finished being created. Your nodes might not end up in the generated schema at compilation, or the process will hang while waiting for an indication that it's finished. |
There was a problem hiding this comment.
Was I right to format sourceNodes as code? We format all words that could be used as code.
Also, now I realize the last sentence in this paragraph doesn't make much sense. Any ideas on how to edit that?
There was a problem hiding this comment.
Also hello! I remember we got to meet last week!
There was a problem hiding this comment.
👋 @shannonbux yes it was great meeting you! Nice change on sourceNodes. Would it be best to drop the last sentence?
There was a problem hiding this comment.
I'll leave it for now and merge this change! Thanks!
There was a problem hiding this comment.
Excellent, thank you!
lipis
added a commit
to lipis/gatsby
that referenced
this pull request
Nov 6, 2018
* 'master' of github.com:gatsbyjs/gatsby: (63 commits) Update how-to-contribute.md to mention the style guide when writing blogs/tutorials (gatsbyjs#9742) Added Tylermcginnis website (gatsbyjs#9619) Fix grammar and punctuation (gatsbyjs#9498) Fix typo of plugin authoring (gatsbyjs#9737) Authentication tutorial - small fixes (gatsbyjs#9738) chore: move run-sift (gatsbyjs#9549) docs: fix minor typo (gatsbyjs#9730) chore(release): Publish fix(gatsby-plugin-page-creator): ensure that __tests__ directory is actually ignored (gatsbyjs#9720) fix: revert admin redirect (gatsbyjs#9728) fix: adjust page order to make nested matchPaths work (gatsbyjs#9719) feat(gatsby-plugin-sharp): cache base64 if possible (gatsbyjs#9059) chore(release): Publish fix(gatsby-plugin-offline): Serve the offline shell for short URLs + use no-cors for external resources (gatsbyjs#9679) chore(release): Publish fix: ensure babel-preset-gatsby can be used with unit tests (gatsbyjs#9629) feat(www): Filter posts by date (gatsbyjs#9400) fix(blog): azure blog post url date (gatsbyjs#9718) feat(blog): Add post on publishing to Azure (gatsbyjs#8868) Emphasize importance of promise return on source-plugin docs (gatsbyjs#9650) ...
gpetrioli
pushed a commit
to gpetrioli/gatsby
that referenced
this pull request
Jan 22, 2019
…s#9650) * emphasize importance of promise return on source-plugin docs * formatted code
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Solves #9459
Makes it more clear in the docs and tutorial for source-nodes that the sourceNodes function should return a promise so that gatsby's build process knows to hold at this stage, until nodes are finished being sourced/created, before moving on.