Skip to content
This repository was archived by the owner on Jan 7, 2023. It is now read-only.

Commit b88719b

Browse files
authored
Merge pull request #339 from ndawe/master
Document RootNumpyUnconvertibleWarning. Fix #332
2 parents 301cb49 + f547e47 commit b88719b

File tree

2 files changed

+9
-1
lines changed

2 files changed

+9
-1
lines changed

docs/reference/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ root_numpy
4141
stretch
4242
dup_idx
4343
blockwise_inner_join
44+
RootNumpyUnconvertibleWarning
4445

4546
root_numpy.tmva
4647
---------------

root_numpy/_warnings.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,13 @@
77

88

99
class RootNumpyUnconvertibleWarning(RuntimeWarning):
10-
pass
10+
"""
11+
This warning is raised when root_numpy is unable to convert a branch into a
12+
column of a NumPy array because there is no converter for the type. If the
13+
user explicitly requests a branch that cannot be converted, an error is
14+
raised. If the user does not specify a list of branches in an attempt to
15+
convert all branches, then this warning is raised for each branch that
16+
cannot be converted and these branches are merely skipped.
17+
"""
1118

1219
warnings.simplefilter('always', RootNumpyUnconvertibleWarning)

0 commit comments

Comments
 (0)