Skip to content

Commit 2b5cae9

Browse files
committed
Improved documentation
1 parent 24cf4ad commit 2b5cae9

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

include/xsimd/types/xsimd_api.hpp

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -486,7 +486,9 @@ namespace xsimd
486486
/**
487487
* @ingroup batch_data_transfer
488488
*
489-
* Creates a batch from the single value \c v.
489+
* Creates a batch from the single value \c v. If \c v is a boolean,
490+
* this function returns a batch_bool<uint8_t>. If you need another type
491+
* of batch_bool, please use broadcast_as instead.
490492
* @param v the value used to initialize the batch
491493
* @return a new batch instance
492494
*/

0 commit comments

Comments
 (0)