Skip to content

docs: simplify abs example by removing dtype #9563

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

Closed
Atharv-K-979 wants to merge 1 commit into from
Closed

docs: simplify abs example by removing dtype #9563

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions lib/node_modules/@stdlib/math/base/special/abs/examples/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,5 @@ var discreteUniform = require( '@stdlib/random/array/discrete-uniform' );
var logEachMap = require( '@stdlib/console/log-each-map' );
var abs = require( './../lib' );

var x = discreteUniform( 100, -100, 100, {
Copy link
Member

@kgryte kgryte Jan 5, 2026

Choose a reason for hiding this comment

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

Conversely, the float64 dtype also signifies that abs accepts and expects double-precision floating-point numbers. As such, I am not convinced that the proposed change is warranted.

Copy link
Author

@Atharv-K-979 Atharv-K-979 Jan 6, 2026

Choose a reason for hiding this comment

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

Thanks for the clarification — I understand your point.

I see that explicitly specifying float64 in the example serves as documentation of the expected input type for abs, rather than being incidental to the example output.

Given that, I agree the change is not warranted. I’m happy to close the PR.

Thanks for taking the time to explain the rationale.

'dtype': 'float64'
});

var x = discreteUniform( 100, -100, 100 );
logEachMap( 'abs(%d) = %d', x, abs );