Ask Your Question

Revision history [back]

click to hide/show revision 1
initial version

Going beyond the documentation

Hi,

this is a common problem I have when using libraries: I want to use a function, however the documentation seem to be incomplete. Sometimes after extensive search I find out that in deed, not all parameters or methods available were listed in the docs.

I know I can look at the source code. However to me, this is not always helpful. If I am using python modules that have been written in cpp I find myself unable to figure out the names of the parameter/method in the python wrap.

Also my favorite python method of using inspect.getmembers() does not seem to work for wrapped libraries. All I can see are the data model methods, but not the parameters or normal methods.

So my questions is, how to go beyond the documentation in these cases? Is there something like "inspect.getmembers()" so I can extract all parameters and methods of an imported class?

particularly I am trying to figure out specifics of the cv2.SimpleBlobDetector.

Going beyond the documentation

Hi,

this is a common problem I have when using libraries: I want to use a function, however the documentation seem to be incomplete. Sometimes after extensive search I find out that in deed, not all parameters or methods available were listed in the docs.

I know I can look at the source code. However to me, this is not always helpful. If I am using python modules that have been written in cpp I find myself unable to figure out the names of the parameter/method in the python wrap.

Also my favorite python method of using inspect.getmembers() does not seem to work for wrapped libraries. All I can see are the data model methods, but not the parameters or normal methods.

So my questions is, how to go beyond the documentation in these cases? Is there something like "inspect.getmembers()" so I can extract all parameters and methods of an imported class?

particularly I am trying to figure out specifics of the cv2.SimpleBlobDetector.cv2.SimpleBlobDetector. Maybe I am unable to search the docs well. But all I could find about this methode is: https://docs.opencv.org/4.1.1/d0/d7a/classcv_1_1SimpleBlobDetector.html

Thank you very much for your help in advance. If there is a good method to go beyond the docs in these cases this would help me out many times!

click to hide/show revision 3
retagged

updated 2019-09-27 05:08:03 -0600

berak gravatar image

Going beyond the documentation

Hi,

this is a common problem I have when using libraries: I want to use a function, however the documentation seem to be incomplete. Sometimes after extensive search I find out that in deed, not all parameters or methods available were listed in the docs.

I know I can look at the source code. However to me, this is not always helpful. If I am using python modules that have been written in cpp I find myself unable to figure out the names of the parameter/method in the python wrap.

Also my favorite python method of using inspect.getmembers() does not seem to work for wrapped libraries. All I can see are the data model methods, but not the parameters or normal methods.

So my questions is, how to go beyond the documentation in these cases? Is there something like "inspect.getmembers()" so I can extract all parameters and methods of an imported class?

particularly I am trying to figure out specifics of the cv2.SimpleBlobDetector. Maybe I am unable to search the docs well. But all I could find about this methode is: https://docs.opencv.org/4.1.1/d0/d7a/classcv_1_1SimpleBlobDetector.html

Thank you very much for your help in advance. If there is a good method to go beyond the docs in these cases this would help me out many times!