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: add the missing deprecated method 'tmpDir()' #27473

Closed
wants to merge 1 commit into from
Closed

doc: add the missing deprecated method 'tmpDir()' #27473

wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented Apr 29, 2019

'tmpDir()' is first introduced in v0.7.11 (https://github.com/nodejs/node/releases/tag/v0.7.11), and then changed from 'tmpDir()' to 'tmpdir()' since v0.9.9 (3fe6aba).
Considering this is a deprecated method, add it as usual in the doc.


  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. os Issues and PRs related to the os subsystem. labels Apr 29, 2019
@ghost ghost changed the title doc: Add the missing deprecated method 'tmpDir()' doc: add the missing deprecated method 'tmpDir()' Apr 29, 2019
@lpinca
Copy link
Member

lpinca commented May 16, 2019

Does it make sense to document it now that is deprecated? I mean it was not documented, why should we do it now?

@ghost
Copy link
Author

ghost commented May 20, 2019

@lpinca:So you mean this wasn't documented on purpose?

@lpinca
Copy link
Member

lpinca commented May 20, 2019

I don't know but I think it's better to keep it undocumented.

Copy link
Contributor

@silverwind silverwind left a comment

Choose a reason for hiding this comment

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

Fine with me to document it I suppose, but please move it below tmpdir so CTRL-F will find the correct function first.

'tmpDir()' is first introduced in v0.7.11 (https://github.com/nodejs/node/releases/tag/v0.7.11),
and then changed from 'tmpDir()' to 'tmpdir()' since v0.9.9
(3fe6aba).
Considering this is a deprecated method, add it as usual in the doc.
@ghost
Copy link
Author

ghost commented May 23, 2019

@silverwind:Thanks! I've corrected that, please have a review.

@tniessen
Copy link
Member

Thank you for the contribution, @ghost, and sorry about the long inactivity!

I don't think we should add new documentation for a previously undocumented, deprecated API. Since node 8, os.tmpDir() has a runtime deprecation, so we have actively discouraged people from using it for at least two years. Adding documentation now seems pointless, if not misleading.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. os Issues and PRs related to the os subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants