akka/akka-core

Directive to include reference.conf info in documentation

Aperta

#24.965 aperta il 24 apr 2018

 (3 commenti) (2 reazioni) (0 assegnatari)Scala (3547 fork)batch import
help wantednice-to-have (low-prio)t:docs

Metriche repository

Star
 (13.277 stelle)
Metriche merge PR
 (Merge medio 8g 19h) (10 PR mergiate in 30 g)

Descrizione

It might be neat if we could create a paradox directive that finds the relevant entry in the reference.conf and includes it, including default value and comment. So in the .md something like

  @@reference[akka.scheduler.tick-duration]

Could automatically turn into:

akka {
  # Used to set the behavior of the scheduler.
  # Changing the default values may change the system behavior drastically so make
  # sure you know what you're doing! See the Scheduler section of the Akka
  # Documentation for more details.
  scheduler {
    # The LightArrayRevolverScheduler is used as the default scheduler in the
    # system. It does not execute the scheduled tasks on exact time, but on every
    # tick, it will run everything that is (over)due. You can increase or decrease
    # the accuracy of the execution timing by specifying smaller or larger tick
    # duration. If you are scheduling a lot of tasks you should consider increasing
    # the ticks per wheel.
    # Note that it might take up to 1 tick to stop the Timer, so setting the
    # tick-duration to a high value will make shutting down the actor system
    # take longer.
    tick-duration = 10ms
}

Guida contributor