nifi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Dan Bress (JIRA)" <j...@apache.org>
Subject [jira] [Commented] (NIFI-434) Improve formatting of machine generated component documentation
Date Mon, 23 Mar 2015 13:59:11 GMT

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

Dan Bress commented on NIFI-434:
--------------------------------

Oh, let me know if you'd prefer "Allowed" or "Allowable".  I went with Allowable because that's
what is in the API.  But looking back, I see you suggested "Allowed" and I think that reads
a little more naturally.

> Improve formatting of machine generated component documentation
> ---------------------------------------------------------------
>
>                 Key: NIFI-434
>                 URL: https://issues.apache.org/jira/browse/NIFI-434
>             Project: Apache NiFi
>          Issue Type: Improvement
>          Components: Core Framework, Documentation & Website
>    Affects Versions: 0.1.0
>            Reporter: Dan Bress
>            Assignee: Dan Bress
>            Priority: Minor
>              Labels: beginner, css, html
>             Fix For: 0.1.0
>
>
> Dan,
> Some feedback to consider.
> - The printout of 'Valid Values' should perhaps read 'Enumerated Values' or simply "Allowed
Values". We're not listing all 'valid' values we're only providing that when there is an enumeration
of allowed values. I just don't want folks to think that those are the only valid values in
cases where it isn't an enumeration.
> - Consider widening 'Valid Values' and 'Default Values' and narrowing the description.



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

Mime
View raw message