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

Improved the documentation to remove ambiquity in call description #1019

Merged
merged 1 commit into from Oct 3, 2017

Conversation

Projects
None yet
4 participants
@PallaviSingh1992
Copy link
Contributor

commented Sep 28, 2017

Pull Request Checklist

Fixes

Fixes #xxxx

Purpose

What does this PR do?

Background Context

Why did you take this approach?

References

Are there any relevant issues / PRs / mailing lists discussions?

@lightbend-cla-validator

This comment has been minimized.

Copy link

commented Sep 28, 2017

Hi @PallaviSingh1992,

Thank you for your contribution! We really value the time you've taken to put this together.

Before we proceed with reviewing this pull request, please sign the Lightbend Contributors License Agreement:

http://www.lightbend.com/contribute/cla

@PallaviSingh1992

This comment has been minimized.

Copy link
Contributor Author

commented Sep 28, 2017

Signed the CLA

@ignasi35

This comment has been minimized.

Copy link
Member

commented Oct 2, 2017

Thanks @PallaviSingh1992 ! This is clearer now. :-)

The documentation in lagom is split/duplicate between java and scala. Would you mind updating also the java version of this doc page? I think it's on docs/manual/java/guide/services/ServiceDescriptors.md.

PS: It's great to see new people contributing.

@ignasi35 ignasi35 added this to the Lagom 1.3.9 milestone Oct 2, 2017

@PallaviSingh1992 PallaviSingh1992 force-pushed the PallaviSingh1992:doc/fixDocumentation branch from a34cdf4 to b60b0bf Oct 3, 2017

@PallaviSingh1992

This comment has been minimized.

Copy link
Contributor Author

commented Oct 3, 2017

@ignasi35 Updated the java version of the documentation aswell.

@@ -14,7 +14,7 @@ An important thing to note here is that invoking the `sayHello` method does not

While the `sayHello` method describes how the call will be programmatically invoked or implemented, it does not describe how this call gets mapped down onto the transport. This is done by providing an implementation of the [`descriptor`](api/com/lightbend/lagom/scaladsl/api/Service.html#descriptor:Descriptor) call, whose interface is described by [`Service`](api/com/lightbend/lagom/scaladsl/api/Service.html).

You can see that we're returning a service named `hello`, and we're describing one call, the `sayHello` call. Because this service is so simple, in this case we don't need to do anything more than simply pass the call the [`call`](api/com/lightbend/lagom/scaladsl/api/Service$.html#call[Request,Response]\(ScalaMethodServiceCall[Request,Response]\)\(MessageSerializer[Request,_],MessageSerializer[Response,_]\):Call[Request,Response]) method.
You can see that we're returning a service named `hello`, and we're describing one call, the `sayHello` call. Because this service is so simple, in this case we don't need to do anything more than simply passing the [`call`](api/com/lightbend/lagom/scaladsl/api/Service$.html#call[Request,Response]\(ScalaMethodServiceCall[Request,Response]\)\(MessageSerializer[Request,_],MessageSerializer[Response,_]\):Call[Request,Response]) method the `sayHello` Service call that we have defined above in the example.

This comment has been minimized.

Copy link
@renatocaval

renatocaval Oct 3, 2017

Member

This text can be exactly the same as the java version. I will adapt it and merge.

@renatocaval renatocaval merged commit 0d85cdf into lagom:master Oct 3, 2017

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
typesafe-cla-validator All users have signed the CLA
Details

renatocaval pushed a commit that referenced this pull request Oct 3, 2017

@renatocaval

This comment has been minimized.

Copy link
Member

commented Oct 3, 2017

Backported on 1.3.x (0a3f2cd)

@renatocaval

This comment has been minimized.

Copy link
Member

commented Oct 3, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.