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

feat: add includes() method to array/fixed-endian-factory #3283

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

ahmad-kashkoush
Copy link

Resolves #3145 .

Description

What is the purpose of this pull request?

This pull request:

Related Issues

Does this pull request have any related issues?

This pull request:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.


@stdlib-js/reviewers

Copy link
Contributor

@stdlib-bot stdlib-bot left a comment

Choose a reason for hiding this comment

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

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

@stdlib-bot
Copy link
Contributor

Coverage Report

Package Statements Branches Functions Lines
array/fixed-endian-factory $\color{red}931/1188$
$\color{green}+78.37\%$
$\color{red}88/97$
$\color{green}+90.72\%$
$\color{red}16/27$
$\color{green}+59.26\%$
$\color{red}931/1188$
$\color{green}+78.37\%$

The above coverage report was generated for the changes in this PR.

@headlessNode headlessNode added the Feature Issue or pull request for adding a new feature. label Nov 27, 2024
@headlessNode
Copy link
Member

@ahmad-kashkoush the title should start with "feat:"

@ahmad-kashkoush ahmad-kashkoush changed the title add includes() method to array/fixed-endian-factory feat: add includes() method to array/fixed-endian-factory Nov 27, 2024
@ahmad-kashkoush
Copy link
Author

@ahmad-kashkoush the title should start with "feat:"

Done, may you review PR?

Copy link
Member

@headlessNode headlessNode left a comment

Choose a reason for hiding this comment

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

@ahmad-kashkoush A few suggestions regarding the documentation, otherwise looks good. A more thorough review will be done by the maintainers. Also you should remove the parenthesis after includes in the title.


#### TypedArrayFE.prototype.includes( searchElement\[, fromIndex] )

Returns `true` if element can be found.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Returns `true` if element can be found.
Returns `true` if the specified `searchElement` is present in the array.

// returns true
```

If `searchElement` is not present in the array, the method returns `false`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
If `searchElement` is not present in the array, the method returns `false`.
If the specified `searchElement` is not present in the array, the method returns `false`.

@@ -675,6 +675,47 @@ function factory( dtype ) { // eslint-disable-line max-lines-per-function, stdli
}
return -1;
});
/**
* A boolean value which is true if the value `searchElement` is found.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* A boolean value which is true if the value `searchElement` is found.
* Returns `true` if the specified `searchElement` is present in the array.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature Issue or pull request for adding a new feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[RFC]: add includes method to array/fixed-endian-factory
3 participants