[ 
https://issues.apache.org/jira/browse/SAMZA-79?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13830168#comment-13830168
 ] 

Chris Riccomini commented on SAMZA-79:
--------------------------------------

Thanks for submission. You kept the same style of comments as things like 
STREAM_JOB_FACTORY_CLASS . I think the current comments are pretty cryptic, in 
general (not your fault -- you're just following the style).

I recommend we write full on /** */ style comments for these variables, and use 
complete sentences to describe what's going on.

job.config.rewriters is a CSV list of config rewriter names. Each name is 
determined by the %s value in job.config.rewriter.%s.class. For example, if you 
define 
job.config.rewriter.some-regex.class=org.apache.samza.config.RegExTopicGenerator,
 then the rewriter config would be set to job.config.rewriters=some-regex.

This style of usage is not really apparent from the existing comments. Could 
you update to express this a bit more clearly?

> Update comments for config rewriters in JobConfig
> -------------------------------------------------
>
>                 Key: SAMZA-79
>                 URL: https://issues.apache.org/jira/browse/SAMZA-79
>             Project: Samza
>          Issue Type: Bug
>    Affects Versions: 0.7.0
>            Reporter: Jakob Homan
>            Assignee: Rekha Joshi
>              Labels: newbie
>             Fix For: 0.7.0
>
>         Attachments: SAMZA_79_1.patch
>
>
> in JobConfig, the configs for the rewriter got converted into a per-system 
> with accompanying system definition value, but the old comment ("CSV list of 
> config...") remains.  We should update both these.



--
This message was sent by Atlassian JIRA
(v6.1#6144)

Reply via email to