[jira] [Commented] (NUTCH-2602) Configuration values in the description of index writers

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view

[jira] [Commented] (NUTCH-2602) Configuration values in the description of index writers

JIRA jira@apache.org

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

Roannel Fernández Hernández commented on NUTCH-2602:

Hi [~wastl-nagel], I agree with you about not remove the description totally from the code. So, you proposed one of this:
 * adding Javadoc comments to the constants
 * comments in indexwriters.xml.template

I include two more options:
 * description attribute for <param> elements. e.g. {{<param name="name" value="value" description="description"/>}}
 * print a table as output of {{describe()}} methods with three columns: Property, Description, Value. We can use one of this: [asciitable|https://github.com/vdmeer/asciitable], [j-text-utils|https://code.google.com/archive/p/j-text-utils/] or create an {{Util}} class for generate an standard and common output.

What do you think is the best option?

> Configuration values in the description of index writers
> --------------------------------------------------------
>                 Key: NUTCH-2602
>                 URL: https://issues.apache.org/jira/browse/NUTCH-2602
>             Project: Nutch
>          Issue Type: Improvement
>          Components: indexer, plugin
>    Affects Versions: 1.15
>            Reporter: Roannel Fernández Hernández
>            Assignee: Roannel Fernández Hernández
>            Priority: Minor
>             Fix For: 1.16
> Since [GitHub Pull Request #218|https://github.com/apache/nutch/pull/218] when you have 2+ different configuration of the same index writers (the same implementation class), the index command print the same description several times. I propose the {{describe()}} method show the values of its own configuration and not a generic one.

This message was sent by Atlassian JIRA