Github user alopresto commented on the pull request:
https://github.com/apache/nifi/pull/246#issuecomment-190332181
@adamonduty You are correct that the `.name`/`.displayName` convention is
not documented well. I pinged @joewitt to look for a canonical source for the
convention and we need to improve the documentation.
In this case, I am ok with not changing the existing `PropertyDescriptors`,
as it would break backwards compatibility as you noted. Unfortunately, this is
a side-effect of the attributes not being set "properly" in the first place --
the `displayName` value is visible to the end user through the UI and may need
to be changed, while the `name` value is used for object resolution in the
application and so should not need to change if the messaging changes (imagine
future internationalization where the `displayName` value is
language-dependent). However, I do think in this case, the new
`PropertyDescriptor` should follow the correct convention and a comment added
noting the reason for the difference with other `PropertyDescriptor`s in the
class.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
