You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by "ASF GitHub Bot (JIRA)" <ji...@apache.org> on 2017/05/15 14:33:04 UTC

[jira] [Commented] (NIFI-3896) DeprecationNotice usage is counter-intuitive

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

ASF GitHub Bot commented on NIFI-3896:
--------------------------------------

GitHub user trixpan opened a pull request:

    https://github.com/apache/nifi/pull/1799

    NIFI-3896 - Makes DeprecationNotice more intuitive

                Update developers guide on how to deprecate a component
    
    Thank you for submitting a contribution to Apache NiFi.
    
    In order to streamline the review of the contribution we ask you
    to ensure the following steps have been taken:
    
    ### For all changes:
    - [X] Is there a JIRA ticket associated with this PR? Is it referenced 
         in the commit message?
    
    - [X] Does your PR title start with NIFI-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
    
    - [X] Has your PR been rebased against the latest commit within the target branch (typically master)?
    
    - [X] Is your initial contribution a single, squashed commit?
    
    ### For code changes:
    - [X] Have you ensured that the full suite of tests is executed via mvn -Pcontrib-check clean install at the root nifi folder?
    - [X] Have you written or updated unit tests to verify your changes?
    - [X] ~~~If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?~~~ 
    - [X] ~~~If applicable, have you updated the LICENSE file, including the main LICENSE file under nifi-assembly?~~~
    - [X] ~~~If applicable, have you updated the NOTICE file, including the main NOTICE file found under nifi-assembly?~~~
    - [X] ~~~If adding new Properties, have you added .displayName in addition to .name (programmatic access) for each of the new properties?~~~
    
    ### For documentation related changes:
    - [X] Have you ensured that format looks appropriate for the output in which it is rendered?
    
    ### Note:
    Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.


You can merge this pull request into a Git repository by running:

    $ git pull https://github.com/trixpan/nifi NIFI-3896

Alternatively you can review and apply these changes as the patch at:

    https://github.com/apache/nifi/pull/1799.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 #1799
    
----
commit b628f8c1d24e437bd1e4c597969e2bfa766ecb61
Author: Andre F de Miranda <tr...@users.noreply.github.com>
Date:   2017-05-15T14:30:02Z

    NIFI-3896 - Makes DeprecationNotice more intuitive
    
                Update developers guide on how to deprecate a component

----


> DeprecationNotice usage is counter-intuitive
> --------------------------------------------
>
>                 Key: NIFI-3896
>                 URL: https://issues.apache.org/jira/browse/NIFI-3896
>             Project: Apache NiFi
>          Issue Type: Bug
>    Affects Versions: 1.3.0
>            Reporter: Andre F de Miranda
>            Assignee: Andre F de Miranda
>
> As part of NIFI-391 we introduced annotation DeprecationNotice. While using it for the first time I developed a feeling that its usage is counter intuitive. 
> The reason for that is that since its original intent was to mimic SeeAlso annotation, the use of "value" was used to describe alternative classes. However, this resulted in awkward annotation use.
> We should use a more explicit name for value, something like {{alternatives}}



--
This message was sent by Atlassian JIRA
(v6.3.15#6346)