Merge pull request #46 from poanetwork/dzol.28.improve-agent-document…

…ation [#28] Introduce section headings for documentation on writing collectors & transfers
poanetwork · May 23, 2018 · 2f87a83 · 2f87a83
2 parents 41ea597 + a0a2f22
commit 2f87a83
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/lib/poa_agent/plugins/collector.ex b/lib/poa_agent/plugins/collector.ex
@@ -49,6 +49,8 @@ defmodule POAAgent.Plugins.Collector do
              {:my_collector, [:my_transfer]}
            ]
 
+  ## Implementing A Collector Plugin
+
   In order to implement your Collector Plugin you must implement 3 functions.
 
   - `init_collector/1`: Called only once when the process starts

diff --git a/lib/poa_agent/plugins/transfer.ex b/lib/poa_agent/plugins/transfer.ex
@@ -29,6 +29,8 @@ defmodule POAAgent.Plugins.Transfer do
   - `module`: Module which implements the Transfer behaviour
   - `args`: Initial args which will be passed to the `init_transfer/1` function
 
+  ## Implementing A Transfer Plugin
+
   In order to implement your Transfer Plugin you must implement 3 functions.
 
   - `init_transfer/1`: Called only once when the process starts