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: update descriptions and add structured package data for math/base/special/gcd #2914

Merged
merged 3 commits into from
Sep 17, 2024

Conversation

gunjjoshi
Copy link
Member

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

@stdlib-bot stdlib-bot added the Math Issue or pull request specific to math functionality. label Sep 17, 2024
@gunjjoshi
Copy link
Member Author

Here, we have different descriptions for the input and return values for JS and C implementations.
JS: https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/%40stdlib/math/base/special/gcd/lib/main.js#L37
C: https://github.com/stdlib-js/stdlib/blob/develop/lib/node_modules/%40stdlib/math/base/special/gcd/src/main.c#L33

I have followed the JS way. But, I think a mix of both would be more appropriate, something like:

a: first number/input value
b: second number/input value
returns: greatest common divisor

Should we change this?

@kgryte
Copy link
Member

kgryte commented Sep 17, 2024

@gunjjoshi Yes, I think you are right. Feel free to make those changes. "first number" and "second number" seems fine to me.

@gunjjoshi
Copy link
Member Author

@gunjjoshi Yes, I think you are right. Feel free to make those changes. "first number" and "second number" seems fine to me.

Done! Thanks.

Copy link
Member

@kgryte kgryte left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks, @gunjjoshi!

@kgryte kgryte changed the title chore: add structured package data for math/base/special/gcd docs: update descriptions and add structured package data for math/base/special/gcd Sep 17, 2024
@kgryte kgryte merged commit 0c994ee into stdlib-js:develop Sep 17, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Math Issue or pull request specific to math functionality.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants