Documentation fix: Execute trailing slash stripping function, rather than assign it. #9924
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
DSchau
suggested changes
Nov 14, 2018
| @@ -121,7 +121,7 @@ exports.onCreatePage = ({ page, actions }) => { | |||
| return new Promise(resolve => { | |||
| const oldPage = Object.assign({}, page) | |||
| // Remove trailing slash unless page is / | |||
| page.path = _path => (_path === `/` ? _path : _path.replace(/\/$/, ``)) | |||
There was a problem hiding this comment.
If we're going to go this route, why not create a function (e.g. const replacePath = _path => // yadda yadda) and then use it like the link you provide? That seems much clearer!
What do you think?
There was a problem hiding this comment.
Absolutely, I guess I just went for the single line change for the sake of keeping it to one line! PR updated
|
Holy buckets, @stevetweeddale — we just merged your PR to Gatsby! 💪💜 Gatsby is built by awesome people like you. Let us say “thanks” in two ways:
If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’. Thanks again! |
gpetrioli
pushed a commit
to gpetrioli/gatsby
that referenced
this pull request
Jan 22, 2019
…than assign it. (gatsbyjs#9924) The trailing slash stripping plugin [executes the function](https://github.com/gatsbyjs/gatsby/blob/f9714a5646523bc728586e3692190507ad68e6c1/packages/gatsby-plugin-remove-trailing-slashes/src/gatsby-node.js#L9) rather than just assigning it, so I'd imagine that's what the example code should be doing too.
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.
The trailing slash stripping plugin executes the function rather than just assigning it, so I'd imagine that's what the example code should be doing too.