-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
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
Fixed ###replace:
tag that led to incorrect docs
#10789
Merged
Merged
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
Docs before: https://www.playframework.com/documentation/2.8.x/PlayApplicationOverview: ```java public Result index() { return ok(views.html.index.render("Your new application is return ok(javaguide.hello.html.index.render("Your new application is ready.", assetsFinder)); } ``` According to https://www.playframework.com/documentation/2.8.x/Documentation ```###replace: foo — Replace the next line with foo. You may optionally terminate this command with ###``` The code sample that was to be run, tested, and injected into the documentation was split into multiple lines (likely by an autoformatter) which made the documentation for the java example incorrect. This PR changes the 'replace' to one line, and also reduces the whitespace on the left to prevent the autoformatter from splitting the line into two.
ignasi35
approved these changes
Apr 6, 2021
ignasi35
reviewed
Apr 6, 2021
Hopefully, the comment has been moved left enough that it won't be split by the formatter. Let's see what the build says
@Mergifyio backport master |
@octonato is not allowed to run commands |
@Mergifyio backport master |
✅ Backports have been created
|
mergify bot
added a commit
that referenced
this pull request
Dec 30, 2021
Fixed `###replace:` tag that led to incorrect docs (backport #10789)
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.
Fixes
Documentation that is incorrect: before
According to https://www.playframework.com/documentation/2.8.x/Documentation
###replace: foo — Replace the next line with foo. You may optionally terminate this command with ###
The code sample that was to be run, tested, and injected into the documentation was split into multiple lines (likely by an autoformatter) which made the documentation for the java example incorrect.
This PR changes the 'replace' to one line, and also reduces the whitespace on the left to prevent the autoformatter from splitting the line into two.
Pull Request Checklist