Skip to content

Commit

Permalink
util: docstring of _sig_checker (#305)
Browse files Browse the repository at this point in the history
  • Loading branch information
iblislin authored and pluskid committed Nov 7, 2017
1 parent a3317f1 commit 8cc5c1c
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions src/util.jl
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,20 @@ end

"""
libmxnet operators signature checker.
C/Python have different convernsion of accessing array. Those languages
handle arrays in row-major and zero-indexing which differs from Julia's
colume-major and 1-indexing.
This function scans the docstrings of NDArray's APIs,
filter out the signature which contain `axis`, `axes`, `keepdims` and `shape`
as its function argument.
We invoks this checker in Travis CI build and pop up the warning message
if the functions does not get manually mapped
(imply it's dimension refering may looks weird).
If you found any warning in Travis CI build, please open an issue on GitHub.
"""
function _sig_checker()
names = filter(n -> (lowercase(n), _op_import_bl), _get_libmx_op_names())
Expand Down

0 comments on commit 8cc5c1c

Please sign in to comment.