[jira] [Updated] (STORM-287) Fix the position of documentation strings

["Rick Kellogg (JIRA)" <ji...@apache.org>]

     [ https://issues.apache.org/jira/browse/STORM-287?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Rick Kellogg updated STORM-287:
-------------------------------
    Component/s: storm-core

> Fix the position of documentation strings
> -----------------------------------------
>
>                 Key: STORM-287
>                 URL: https://issues.apache.org/jira/browse/STORM-287
>             Project: Apache Storm
>          Issue Type: Bug
>          Components: storm-core
>            Reporter: Muneyuki Noguchi
>            Assignee: Muneyuki Noguchi
>            Priority: Minor
>             Fix For: 0.9.2-incubating
>
>
> A documentation string should be between a function name
> and a parameter list, but some strings are not.
> {noformat}
> (defn number-duplicates [coll]
>   "(number-duplicates [\"a\", \"b\", \"a\"]) => [\"a\", \"b\", \"a#2\"]"
>   (map-occurrences (fn [x occurences] (if (>= occurences 2) (str x "#" occurences) x)) coll))
> {noformat}
> {noformat}
> (defn metrics-consumer-register-ids [storm-conf]
>   "Generates a list of component ids for each metrics consumer
> e.g. [\"__metrics_org.mycompany.MyMetricsConsumer\", ..] "
>   (->> (get storm-conf TOPOLOGY-METRICS-CONSUMER-REGISTER)
>        (map #(get % "class"))
>        (number-duplicates)
>        (map #(str Constants/METRICS_COMPONENT_ID_PREFIX %))))
> {noformat}



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)