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: fix util.isObject documentation #1295

Merged
merged 1 commit into from
Mar 31, 2015

Conversation

Fishrock123
Copy link
Contributor

Puts #743 to rest for good.

The change to fix the functionality would be too radical.

Replaces #822 (arguments for this are also contained in that thread).

These functions should probably be deprecated later. Maybe post-2.0.0?

@Fishrock123 Fishrock123 added util Issues and PRs related to the built-in util module. doc Issues and PRs related to the documentations. labels Mar 30, 2015
@@ -328,7 +328,7 @@ Returns `true` if the given "object" is `undefined`. `false` otherwise.

## util.isObject(object)

Returns `true` if the given "object" is strictly an `Object`. `false` otherwise.
Returns `true` if the given "object" is strictly an `Object` __and__ not a `Function`. `false` otherwise.
Copy link
Member

Choose a reason for hiding this comment

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

Can you wrap this at 80 columns?

@bnoordhuis
Copy link
Member

LGTM with style nit.

@Fishrock123
Copy link
Contributor Author

Updated.

@bnoordhuis
Copy link
Member

LGTM

@brendanashworth
Copy link
Contributor

Regarding the deprecation, I don't see any reason to postpone it beyond 2.0.0; we'd just be digging ourselves in a bigger hole if we plan on eventually removing it. I'd love to see lots of things deprecated before 2.0.0 to clean up the API, as there are a few function references and stuff that I think many would like to see deprecated and removed but they're just being kept. Though they may not be removed for some time, it'd free us up to remove them sooner rather than later.

+1 for this PR

Proposed functionality fix containing prior discussion:
nodejs#822

Fixes: nodejs#743
PR-URL: nodejs#1295
Reviewed-By: Ben Noordhuis <[email protected]>
Reviewed-By: Brendan Ashworth <[email protected]>
@Fishrock123 Fishrock123 merged commit 245ba1d into nodejs:v1.x Mar 31, 2015
@Fishrock123
Copy link
Contributor Author

Thanks!

@brendanashworth I'm going to open a new issue/pr for deprecation

This was referenced Mar 31, 2015
@Fishrock123 Fishrock123 deleted the fix-isObject-docs branch April 4, 2015 05:35
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. util Issues and PRs related to the built-in util module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants