Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upCorrect Java snippet rendering in Hello World tutorial #10421
Conversation
The PlayDoc "###replace" directive only matches single lines, which caused the generated code to be jumbled with the replaced snippet and be incompilable. Aligned indentation with the other directives as well.
|
@Mergifyio backport master |
|
Command
|
|
The build fails because the java formatter splits the comment into shorter lines: public Result index() {
- // ###replace: return ok(views.html.index.render("Your new application is ready.", assetsFinder));
+ // ###replace: return ok(views.html.index.render("Your new application is ready.",
+ // assetsFinder));
return ok(javaguide.hello.html.index.render("Your new application is ready.", assetsFinder));
} |
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.
This PR corrects a rendering error for a Java snippet from the Hello World tutorial. Specifically, versions 2.8.2 and 2.8.x of the Play Application Overview provide the following Java code:
which is meaningless and won't compile.
The problem is caused by the
###replace:directive from the PlayDoc library. Its purpose is to replace the code underneath the directive with the code directly after the directive. However, it cannot handle newlines within its input, so this fix turns it into a one-liner.It might be useful to extend the PlayDoc with multiline replace directives if they get more future use, but this is a much more reasonable fix for now.
Lastly, I slightly changed the spacing between
###replace:and the code snippet to be replaced. It now aligns with the other replace directives in the file.Cheers