You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2016/04/21 04:15:25 UTC
[jira] [Commented] (NIFI-1795) Improve documentation regarding
PropertyDescriptor name & displayName
[ https://issues.apache.org/jira/browse/NIFI-1795?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15251117#comment-15251117 ]
ASF GitHub Bot commented on NIFI-1795:
--------------------------------------
GitHub user alopresto opened a pull request:
https://github.com/apache/nifi/pull/373
NIFI-1795 Temporarily ignored incorrectly failing test
TestPutUDP#testUnknownHostname.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/alopresto/nifi master
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/nifi/pull/373.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #373
----
commit 993418e29364d32188abdf557c9441c2f18189a2
Author: Andy LoPresto <al...@apache.org>
Date: 2016-04-21T02:13:57Z
NIFI-1795 Temporarily ignored incorrectly failing TestPutUDP#testUnknownHostname.
----
> Improve documentation regarding PropertyDescriptor name & displayName
> ---------------------------------------------------------------------
>
> Key: NIFI-1795
> URL: https://issues.apache.org/jira/browse/NIFI-1795
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Documentation & Website
> Affects Versions: 0.6.1
> Reporter: Andy LoPresto
> Priority: Minor
> Fix For: 1.0.0, 0.7.0
>
>
> As evidenced in numerous pull requests, developers are often unaware of the behavior of {{PropertyDescriptor}} {{name}} and {{displayName}} attributes. Originally, {{name}} existed and served as both the UI display value for the processor properties configuration dialog and as the unique identifier when writing/reading the properties from file storage. However, a change to the {{name}} value after the flow had been persisted could cause issues retrieving the value from file storage. Thus, {{displayName}} was introduced as the UI display value to allow for backward-compatible updates. The documentation does not sufficiently explain this information and can better encourage developers to provide both {{name}} and {{displayName}} attributes in order to be proactive on flow compatibility and to improve the foundation for internationalization and localization of the UI.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)