Missing documentation (Bug #3184)


Added by Pradeep Kumar J over 11 years ago. Updated almost 10 years ago.


Status:Cancelled Start date:2013-07-31
Priority:Low Due date:
Assignee:abid rahman % Done:

0%

Category:documentation
Target version:3.0
Affected version:branch 'master' (3.0-dev) Operating System:Any
Difficulty:Easy HW Platform:Any
Pull request:

Description

Missing documentation for Python version of HOGDescriptor.


Related issues

duplicates Bug #1215: Undocumented functions/methods in API exported to java/py... Open

Associated revisions

Revision 0276cc90
Added by Vadim Pisarevsky over 10 years ago

Merge pull request #3184 from ilya-lavrenov:arm

History

Updated by Victor Kocheganov over 11 years ago

Hello Pradeep Kumar,

thank you for finding the absence of documentation and it would be great if you have a chanсe to compose HOGDescriptor documentation by yourself (please see http://code.opencv.org/projects/opencv/wiki/How_to_contribute for details). Your work wil be definitely appreciated by the community!

Thank you in advance,
Victor

  • Category changed from python bindings to documentation
  • Status changed from New to Open
  • Target version set to 3.0-alpha
  • Assignee changed from Vadim Pisarevsky to Andrey Pavlenko

Updated by Steven Puttemans over 11 years ago

I was just wondering if it is not possible to generate the python docs from the existing C++ docs. It would spare a lot of work right?

Updated by Victor Kocheganov over 11 years ago

Since you spent some time to investigate this descriptor, I believe it will be much easier for you to create documentation as experienced user than anybody else.

Do you think you could handle this, Steven?

  • Affected version changed from 2.4.6 (latest release) to 2.4.7 (latest release)

Updated by Steven Puttemans over 11 years ago

Will see later on if i can find the time to do so. This is a rather large adaptation that needs to be done and I don't have a working python setup to check if my code is actually correct :P Will put notice here if I should start this, but I guess the original author can try also?

Updated by abid rahman almost 11 years ago

Hello Steven Puttemans

What is your status on this issue? Have you started it? If not started yet, I think I can work on it, if you don't mind.

  • Affected version changed from 2.4.7 (latest release) to branch 'master' (3.0-dev)

Updated by Steven Puttemans almost 11 years ago

Go ahead! I don't had the time to start it yet, nor the configuration available.

  • Assignee changed from Andrey Pavlenko to abid rahman

Updated by Maksim Shabunin almost 10 years ago

  • Target version changed from 3.0-alpha to 3.0

Updated by Maksim Shabunin almost 10 years ago

The python documentation generation should be reworked, will be tracked by #1215.

  • Status changed from Open to Cancelled

Also available in: Atom PDF