Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add some docstrings to gen2.py #16767

Closed
wants to merge 1 commit into from
Closed

Conversation

archit120
Copy link

Some documentation for python bindings generator file gen2.py.

Original issue: #16339

Pull Request Readiness Checklist

See details at https://github.com/opencv/opencv/wiki/How_to_contribute#making-a-good-pull-request

  • I agree to contribute to the project under OpenCV (BSD) License.
  • To the best of my knowledge, the proposed patch is not based on a code under GPL or other license that is incompatible with OpenCV
  • The PR is proposed to proper branch
  • There is reference to original bug report and related work
  • There is accuracy test, performance test and test data in opencv_extra repository, if applicable
    Patch to opencv_extra has the same branch name.
  • The feature is well documented and sample code can be built with the project CMake

Some documentation for python bindings generator file gen2.py
@VadimLevin
Copy link
Contributor

@archit120 Thank you for the contribution! I think docstring should contain an example of usage describing expected behavior like it is done for libraries like NumPy or SciPy.
This info not only demonstrates how this function can be called but can be used with pydoctest or be converted to actual test cases.
Can you update your docs with it and add appropriate tests for python bindings generator?

@asmorkalov asmorkalov added pr: Discussion Required pr: needs rebase Rebase patch (and squash fixup commits) on the top of target branch labels Mar 20, 2020
@asmorkalov asmorkalov requested a review from alalek March 20, 2020 09:36
@asmorkalov asmorkalov removed the pr: needs rebase Rebase patch (and squash fixup commits) on the top of target branch label Mar 20, 2020
@asmorkalov
Copy link
Contributor

@archit120 The patch was discussed on OpenCV team weekly meeting and @alalek @asmorkalov @VadimLevin @vladimir-dudnik @vpisarev decided to reject it because it brings small additional value and introduce extra conflicts during 3.4 merge to master.

@asmorkalov asmorkalov closed this Mar 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants