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

[NICE FIRST CONTRIB] Additional examples for Stream operator docs #25468

Open
raboof opened this Issue Aug 13, 2018 · 3 comments

Comments

Projects
None yet
5 participants
@raboof
Member

raboof commented Aug 13, 2018

Many operators in the stream operator documentation section at https://doc.akka.io/docs/akka/current/stream/operators/index.html do not yet have code examples. Adding such a code example is a great contribution.

Examples of operators that does have example code are:
https://doc.akka.io/docs/akka/current/stream/operators/Source-or-Flow/log.html https://doc.akka.io/docs/akka/current/stream/operators/ActorFlow/ask.html .

Example code in Akka is included in the source tree and is compiled (and thus typechecked) on every build. Sometimes the examples even come from unit tests, so they are not only compiled but even ran and validated. If you can add or find a test that can be used as documentation that is great, otherwise the code can be added to the akka-docs subproject.

To add an example:

  • Optionally, comment in this issue to 'claim' an operator
  • Add (or find) example code, mark it as a Paradox snippet (with //#xxx comments)
  • Add a snippet to the markdown file of your operator to include that snippet
@patriknw

This comment has been minimized.

Member

patriknw commented Sep 20, 2018

I agree, this is an excellent community ticket and we really need the help to complete all of it.

@patriknw patriknw removed this from the 2.5.17 milestone Sep 20, 2018

@salehkhazaei

This comment has been minimized.

Contributor

salehkhazaei commented Sep 20, 2018

I'll do the Fan-in operators. Have little time this week, might take a while :)

salehkhazaei added a commit to salehkhazaei/akka that referenced this issue Sep 21, 2018

@raboof raboof modified the milestone: 2.5.17 Sep 24, 2018

patriknw added a commit that referenced this issue Oct 2, 2018

Add examples for zipWithIndex #25468 (#25661)
* Add examples for zipWithIndex #25468

* better examples
@mehdimousavi1995

This comment has been minimized.

Contributor

mehdimousavi1995 commented Oct 4, 2018

I'll do The Sink operators.

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 4, 2018

salehkhazaei added a commit to salehkhazaei/akka that referenced this issue Oct 12, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 12, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 12, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 12, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 12, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 12, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 15, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 15, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 15, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 15, 2018

mehdimousavi1995 added a commit to mehdimousavi1995/akka that referenced this issue Oct 16, 2018

johanandren added a commit that referenced this issue Oct 25, 2018

example for some sink operators #25468
Examples for takeLast, last and lastOption operators
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment