Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: unambiguously mark deprecated signatures #942

Closed
wants to merge 1 commit into from

Conversation

tniessen
Copy link
Member

Currently, deprecation notices are always right between two function signatures and it's virtually impossible to be certain whether they refer to the previous signature or the next signature:

`void foo()`

This signature is deprecated.

`void bar()`

It would be great if someone could confirm that it is indeed always the above signature that's deprecated.

Currently, deprecation notices are always right between two function
signatures and it's virtually impossible to be certain whether they
refer to the previous signature or the next signature.
@legendecas
Copy link
Member

I believe it is the one above that been deprecated. See #343 and https://github.com/nodejs/node-addon-api/blob/main/napi.h#L1465.

/cc @gabrielschulhof

@NickNaso NickNaso added the doc label Mar 22, 2021
@mhdawson
Copy link
Member

Also by looking at at https://github.com/nodejs/node-addon-api/blob/main/napi-inl.deprecated.h looks to confirm that it is the "above" one that is deprecated.

Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

gabrielschulhof pushed a commit that referenced this pull request Mar 29, 2021
Currently, deprecation notices are always right between two function
signatures and it's virtually impossible to be certain whether they
refer to the previous signature or the next signature.

PR-URL: #942
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@gabrielschulhof
Copy link
Contributor

Landed in 0127813.

deepakrkris pushed a commit to deepakrkris/node-addon-api that referenced this pull request Sep 23, 2021
Currently, deprecation notices are always right between two function
signatures and it's virtually impossible to be certain whether they
refer to the previous signature or the next signature.

PR-URL: nodejs#942
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@tniessen tniessen deleted the unambiguous-deprecations branch October 7, 2021 16:52
deepakrkris pushed a commit to deepakrkris/node-addon-api that referenced this pull request Oct 15, 2021
Currently, deprecation notices are always right between two function
signatures and it's virtually impossible to be certain whether they
refer to the previous signature or the next signature.

PR-URL: nodejs#942
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
kevindavies8 added a commit to kevindavies8/node-addon-api-Develop that referenced this pull request Aug 24, 2022
Currently, deprecation notices are always right between two function
signatures and it's virtually impossible to be certain whether they
refer to the previous signature or the next signature.

PR-URL: nodejs/node-addon-api#942
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Marlyfleitas added a commit to Marlyfleitas/node-api-addon-Development that referenced this pull request Aug 26, 2022
Currently, deprecation notices are always right between two function
signatures and it's virtually impossible to be certain whether they
refer to the previous signature or the next signature.

PR-URL: nodejs/node-addon-api#942
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
wroy7860 added a commit to wroy7860/addon-api-benchmark-node that referenced this pull request Sep 19, 2022
Currently, deprecation notices are always right between two function
signatures and it's virtually impossible to be certain whether they
refer to the previous signature or the next signature.

PR-URL: nodejs/node-addon-api#942
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
johnfrench3 pushed a commit to johnfrench3/node-addon-api-git that referenced this pull request Aug 11, 2023
Currently, deprecation notices are always right between two function
signatures and it's virtually impossible to be certain whether they
refer to the previous signature or the next signature.

PR-URL: nodejs/node-addon-api#942
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants