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

Docs: Removed internal is* properties. #18217

Merged
merged 1 commit into from
Dec 20, 2019
Merged

Docs: Removed internal is* properties. #18217

merged 1 commit into from
Dec 20, 2019

Conversation

mrdoob
Copy link
Owner

@mrdoob mrdoob commented Dec 20, 2019

I don't think we should document these.

@mrdoob mrdoob added this to the r112 milestone Dec 20, 2019
@mrdoob mrdoob merged commit 7f50ffc into dev Dec 20, 2019
@mrdoob mrdoob deleted the docs branch December 20, 2019 19:32
@donmccurdy
Copy link
Collaborator

Hm, do you disagree with my comment at #18195 (comment)? I don't necessarily feel strongly that the properties need to be documented, but I hadn't personally considered them "internal", and I definitely prefer to use them in application code versus .type === "Mesh".

Ideally foo instanceof Mesh would just work, but was there some issue with that? I can't remember why we don't use it internally and use isFoo instead.

@mrdoob
Copy link
Owner Author

mrdoob commented Dec 20, 2019

I do not disagree.
You can use them but language like "default is true" in the documentation was confusing.

@mrdoob
Copy link
Owner Author

mrdoob commented Dec 20, 2019

If we're going to document them, we can automate it with .is[name].
But I don't think I would call it a Boolean as it makes you think you can change it.

@donmccurdy
Copy link
Collaborator

Ok, thanks — I don't mind removing it from the API documentation.

@yomotsu yomotsu mentioned this pull request Aug 11, 2020
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants