Skip to content
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

[1.5.x] Documentation - "Serialization" page grammar improvements. #2511

Merged

Conversation

BillyAutrey
Copy link

Pull Request Checklist

Fixes

N/A

Purpose

Improves grammar and sentence structure in key places on the "Serialization" Scala page. Improves readability, without changing the content.

Improved sentence structure and tense errors in the documentation.  The goal was to preserve the meaning, while improving readability.
@BillyAutrey BillyAutrey requested a review from a team as a code owner December 4, 2019 19:17
Copy link
Contributor

@ignasi35 ignasi35 left a comment

Choose a reason for hiding this comment

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

This looks great @BillyAutrey, thanks!

Would it be possible for you to make the same improvements on the /java/guide version of this same file (Lagom has each page in the docs duplicated)

@ignasi35
Copy link
Contributor

Note to self (and maintainers): this PR targets 1.5.x we'll have to forward port (unless @BillyAutrey rebuilds the PR on top of 1.6.x and we let mergify and the status:needs-backport-1.5label do their magic).

@BillyAutrey
Copy link
Author

Sure @ignasi35, I can add a commit for the Java docs. I can also look at the 1.6.x docs and add another PR for that. Should be a straightforward comparison.

@octonato
Copy link
Member

@BillyAutrey, you don't need to send another PR. Let me try to re-target this one.

@octonato octonato changed the base branch from 1.5.x to 1.6.x December 11, 2019 14:54
@octonato octonato changed the base branch from 1.6.x to 1.5.x December 11, 2019 14:55
@octonato
Copy link
Member

Hmm, didn't work. The best is to close it and send it to 1.6.x

@ignasi35
Copy link
Contributor

Hmm, didn't work. The best is to close it and send it to 1.6.x

rebase the branch on top of 1.6.x and force push?

@ignasi35
Copy link
Contributor

rebase the branch on top of 1.6.x and force push?

The contents of the Serialization.md pages has changed a lot between branches 1.5.x so the back/forward-porting causes a good deal of CONFLICTs.

I think we're better off just targeting 1.5.x and, eventually, we'll review the contents on 1.6.x (if amendments are necessary there).

@ignasi35
Copy link
Contributor

Would it be possible for you to make the same improvements on the /java/guide version of this same file (Lagom has each page in the docs duplicated)

I was cmparing the changes in this PR with the contents on the java/guide just to realise the contents of Serialization.md are extremely different in each implementation (because one uses jackson and the other uses play-json).

@ignasi35
Copy link
Contributor

I think this should be merged without forward-porting and without any changes on java/guide.

thanks @BillyAutrey !

@ignasi35
Copy link
Contributor

I think this should be merged without forward-porting and without any changes on java/guide.

thanks @BillyAutrey !

@mergify mergify bot merged commit 68ab7ef into lagom:1.5.x Dec 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants