{{ message }}
Repository navigation
Where is documentation? #522
Description
After much searching, I found this: https://opencv-python-tutroals.readthedocs.io/en/latest/ It says it's abandoned. The C++ documentation doesn't seem to include anything meaningful about this package (it only tells you how to build Python bindings).
PyPI page dedicated to this package only has the title "Documentation for opencv-python", but there's nothing there. Does the documentation even exist?
Activity
sergregory commentedon Aug 5, 2021
Actually, the C++ documentation at docs.opencv.org includes the Python function name with all the parameters for each of the C++ functions that are exported to python module (absolute majority of OpenCV functionality is exported to Python bindings). For example, look here: https://docs.opencv.org/4.5.3/d7/dfc/group__highgui.html#ga0f11fad74a6432b8055fb21621a0f893
Another handy option that I personally use a lot is offline docs browsing the Zeal/Dash - https://zealdocs.org/. They have both C++ and Python docsets for OpenCV (generated just the same way as official docs @ docs.opencv.org do it)
abhiTronix commentedon Aug 5, 2021
@wvxvw Nope, Actually OpenCV-Python documents available from OpenCV devs on there website itself: https://docs.opencv.org/master/d6/d00/tutorial_py_root.html. Please check docs before creating issue anywhere.
sergregory commentedon Aug 5, 2021
Well, now I'm confused.. AFAIK there is no such thing as cv2.Image. All the C++ functionality is written around cv::Mat, but when we switch to the Python world, all Python bindings expect numpy arrays where C++ functions expect cv::Mat. And this is what all opencv-python users expect (again, to the best of my knowledge) - provide numpy array as input and get output from opencv-python as numpy array (where it is suitable).
There is an initiative on adding typing to Python bindings that is part of this year's google summer of code. You cna track the progress here: opencv/opencv#20370
abhiTronix commentedon Aug 5, 2021
@wvxvw Ignorance is bliss. I quoted the section of your comment you made and then answered it. Also, Have you tried opening any of those examples? It contains explanation for importing and its usage and highlighted links to OpenCV function/method used in that example.
Moreover, Python binding is just like C++ with few changes like how arrays are handled, any beginner can easily understand them.
abhiTronix commentedon Aug 5, 2021
real know-it-all
WASasquatch commentedon May 3, 2023
That is most certainly not proper documentation. That's source, and I don't even know what the point of dropping the function headers only as "documentation" that you highlighted. That's useless.