Skip to content

calib3d: Update documentation of calibrateCamera#20018

Merged
opencv-pushbot merged 1 commit intoopencv:3.4from
guillaume-jcb:doc_fixes_calib3d
May 1, 2021
Merged

calib3d: Update documentation of calibrateCamera#20018
opencv-pushbot merged 1 commit intoopencv:3.4from
guillaume-jcb:doc_fixes_calib3d

Conversation

@guillaume-jcb
Copy link
Copy Markdown
Contributor

@guillaume-jcb guillaume-jcb commented Apr 30, 2021 •
edited
Loading

  • Added missing documentation for the CALIB_FIX_FOCAL_LENGTH flag
  • Removed erroneous information about the number of distortion coefficients
    returned
  • Added some missing @ref tags

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 Apache 2 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

@alalek
Copy link
Copy Markdown
Member

alalek commented Apr 30, 2021

Thank you for contribution!

This patch should go into 3.4 branch first.
We will merge changes from 3.4 into master regularly (weekly/bi-weekly).

Please:

  • change "base" branch of this PR: master => 3.4 (use "Edit" button near PR title)
  • rebase your commits from master onto 3.4 branch. For example:
    git rebase -i --onto upstream/3.4 upstream/master
    (check list of your commits, save and quit (Esc + "wq" + Enter)
    where upstream is configured by following this GitHub guide and fetched (git fetch upstream).
  • push rebased commits into source branch of your fork (with --force option)

Note: no needs to re-open PR, apply changes "inplace".

@guillaume-jcb guillaume-jcb changed the base branch from master to 3.4 April 30, 2021 18:33
@guillaume-jcb
calib3d: Update documentation of calibrateCamera
9f3e83b 
- Added missing documentation for the CALIB_FIX_FOCAL_LENGTH flag
- Removed erroneous information about the number of distortion coefficients
returned
- Added some missing @ref tags
@guillaume-jcb
Copy link
Copy Markdown
Contributor Author

guillaume-jcb commented Apr 30, 2021

@alalek Thanks for the instructions, it should be good now.

Is it a general rule that all PRs should target the 3.4 branch? To be honest this is not the first time that I make this mistake, so I had a look at the How to contribute page on the wiki before opening this PR but did not find any explicit mention of this workflow. I'll try to remember for the next one!

alalek
alalek approved these changes May 1, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@alalek alalek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well done! Thank you 👍

@opencv-pushbot opencv-pushbot merged commit 8550f7e into opencv:3.4 May 1, 2021
@alalek alalek mentioned this pull request May 1, 2021
Merged
@alalek alalek mentioned this pull request Jun 4, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alalek alalek alalek approved these changes

Assignees

@alalek alalek

Labels

category: calib3d category: documentation Documentation fix or update

Projects

None yet

Milestone

3.4.15

Development

Successfully merging this pull request may close these issues.

3 participants

@guillaume-jcb @alalek @opencv-pushbot