documentation tickets

[Tim Pigden]

In reading the documentation there may be things that could be more usefully described. 

Example on the EventBus page all extend  EventBus but actually duplicate the code from

trait ActorEventBus extends EventBus {

  type Subscriber = ActorRef

  protected def compareSubscribers(a: ActorRef, b: ActorRef) = a compareTo b

}

so should really extend ActorEventBus instead. 

If I spot things like this is it appropriate to raise a ticket? I don't want to seem like a document nit-picker!

Tim

[Patrik Nordwall]

Hi Tim,

We appreciate such improvements very much. Please open ticket and if possible a pull request fixing the issue.

Regards,

Patrik 

--
>>>>>>>>>> Read the docs: http://akka.io/docs/
>>>>>>>>>> Check the FAQ: http://doc.akka.io/docs/akka/current/additional/faq.html
>>>>>>>>>> Search the archives: https://groups.google.com/group/akka-user
---
You received this message because you are subscribed to the Google Groups "Akka User List" group.
To unsubscribe from this group and stop receiving emails from it, send an email to akka-user+...@googlegroups.com.
To post to this group, send email to akka...@googlegroups.com.
Visit this group at http://groups.google.com/group/akka-user.
For more options, visit https://groups.google.com/d/optout.

--

Patrik Nordwall
Typesafe -  Reactive apps on the JVM
Twitter: @patriknw

JOIN US. REGISTER TODAY!

Scala

Days

June 16th-18th,

Berlin

[Tim Pigden]

Are there rules for the docs?

For example - what if my searches have found an excellent blog article on the topic? Can I reference it? Or a discussion thread here?

Or a chapter in one of the books? (I'm sure the authors would be happy for a plug)

You received this message because you are subscribed to a topic in the Google Groups "Akka User List" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/akka-user/WokS-Dxa-5Y/unsubscribe.
To unsubscribe from this group and all its topics, send an email to akka-user+...@googlegroups.com.

To post to this group, send email to akka...@googlegroups.com.
Visit this group at http://groups.google.com/group/akka-user.
For more options, visit https://groups.google.com/d/optout.

--

Tim Pigden
Optrak Distribution Software Limited
+44 (0)1992 517100
http://www.linkedin.com/in/timpigden
http://optrak.com
Optrak Distribution Software Ltd is a limited company registered in England and Wales.
Company Registration No. 2327613 Registered Offices: Suite 6,The Maltings, Hoe Lane, Ware, SG12 9LR England 
This email and any attachments to it may be confidential and are intended solely for the use of the individual to whom it is addressed. Any views or opinions expressed are solely those of the author and do not necessarily represent those of Optrak Distribution Software Ltd. If you are not the intended recipient of this email, you must neither take any action based upon its contents, nor copy or show it to anyone. Please contact the sender if you believe you have received this email in error.

[Konrad Malawski]

Hello Tim!

I think the docs should be mostly "self contained" - as in, if I'm in the woods in Laponia with no WiFi, with the docs downloaded, I should be able to figure out what I need from the docs :-)

You are very welcome to open issues and pull requests!

--

Cheers,

Konrad 'ktoso' Malawski

hAkker - Typesafe, Inc

[Patrik Nordwall]

On Thu, Apr 24, 2014 at 11:14 AM, Tim Pigden <tim.p...@optrak.com> wrote:

Are there rules for the docs?

For example - what if my searches have found an excellent blog article on the topic? Can I reference it?

The documentation is versioned to a specific Akka version and it could be a problem that the blog post is no longer valid. Sometimes it could be alright. I think we have a few such links.

 

Or a discussion thread here?

No. In that case the essence of the thread should be included in the documentation.

 

Or a chapter in one of the books? (I'm sure the authors would be happy for a plug)

I'm not sure. I don't think so, because the reference documentation should be not rely on things that are not online (and free). Books can be added to this section: http://doc.akka.io/docs/akka/2.3.2/additional/books.html

/Patrik

[Tim Pigden]

Hi

Guidelines say not to start work until the ticket has been reviewed. Is that necessary here?

[Patrik Nordwall]

On Thu, Apr 24, 2014 at 12:04 PM, Tim Pigden <tim.p...@optrak.com> wrote:

Hi

Guidelines say not to start work until the ticket has been reviewed. Is that necessary here?

Go ahead, guidelines are not rules. I think the purpose of that is to agree on bigger features.