Skip to content
/ stdlib Public

docs: update function description in math/base/special/log #2808

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Aug 18, 2024
Merged

docs: update function description in math/base/special/log #2808

merged 13 commits into from
Aug 18, 2024
+11 −11

Conversation

gunjjoshi
Copy link
Member

@gunjjoshi gunjjoshi commented Aug 18, 2024 •
edited
Loading

Description

What is the purpose of this pull request?

This pull request:

Related Issues

Does this pull request have any related issues?

None.

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

Sorry, something went wrong.

@gunjjoshi
docs: update function description
Loading
Loading status checks…
0d03fda 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@stdlib-bot stdlib-bot added the Math Issue or pull request specific to math functionality. label Aug 18, 2024
@gunjjoshi
Update index.js
Loading
Loading status checks…
d604a42 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@gunjjoshi
Update package.json
Loading
Loading status checks…
7cf43d1 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
Planeshifter
Planeshifter reviewed Aug 18, 2024
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

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

Wondering whether we should change the description to

Compute the base b logarithm of a double-precision floating-point number.

everywhere for this package instead (assuming we may want to add logf down the road...)

@gunjjoshi
Copy link
Member Author

@Planeshifter Yes, this caught my eye as I was working on logf. I'll change it according to your suggestion, everywhere in log and future logf.

@gunjjoshi
Update index.d.ts
Loading
Loading status checks…
96afdee 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@gunjjoshi
Update repl.txt
Loading
Loading status checks…
9fff10b 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@gunjjoshi
Update log.h
Loading
Loading status checks…
9cd83ae 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@gunjjoshi
Update index.js
Loading
Loading status checks…
a3df367 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@gunjjoshi
Update main.js
Loading
Loading status checks…
b40d0b0 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@gunjjoshi
Update native.js
Loading
Loading status checks…
2c641cb 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@gunjjoshi
Update main.c
Loading
Loading status checks…
322d0dc 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@gunjjoshi
Update README.md
Loading
Loading status checks…
4a57082 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
@gunjjoshi
Update package.json
Loading
Loading status checks…
e4a4b4d 
Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
Planeshifter
Planeshifter approved these changes Aug 18, 2024
View reviewed changes
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

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

Thanks, @gunjjoshi!

@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Aug 18, 2024
@Planeshifter
Update lib/node_modules/@stdlib/math/base/special/log/README.md
Loading
Loading status checks…
f82158a 
Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>
@Planeshifter Planeshifter merged commit 588c4b4 into stdlib-js:develop Aug 18, 2024
9 checks passed
gunjjoshi added a commit to gunjjoshi/stdlib that referenced this pull request Aug 21, 2024
@gunjjoshi @Planeshifter
docs: update function description in math/base/special/log
2bcd3c8 
PR-URL: stdlib-js#2808

---------

Signed-off-by: Gunj Joshi <gunjjoshi8372@gmail.com>
Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>
Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Planeshifter Planeshifter

Assignees
No one assigned
Labels
Math Issue or pull request specific to math functionality. Ready To Merge A pull request which is ready to be merged.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@gunjjoshi @Planeshifter @stdlib-bot