bluescarni/heyoka.py

[DOCUMENTATION FEATURE] Requesting information from "logger messages" on heyoka.py

hfsf opened this issue · 3 comments

hfsf commented

I suggest the inclusion of some sort of explanation for the logging message output when heyoka.py is imported

[heyoka] [info] heyoka logger initialised

Nothing is mentioned in the documentation. If it is a debug message, it should be interesting to provide an flag option for switching out those.

Yes, this is essentially a debug message coming from the C++ library. I'll make sure to remove it in the next version.

The heyoka C++ library has a logging mechanism which connects to the Python logging module, so that log messages generated in the C++ code are copied over to a the Python logger. I haven't gotten around to documenting this part of the code yet though.

I opened a PR for the removal of the debug message in release builds: bluescarni/heyoka#130.

@hfsf I have released version 0.8.0 of both the C++ and Python versions of the library, the debug message should be gone. I will eventually add some documentation regarding the logging module.

I will close this IR in the meantime, thanks for the report.