typo on “The OpenCV Coding Style Guide” (Bug #4126)

Added by Craig Reynolds about 10 years ago. Updated almost 10 years ago.

Status:Done Start date:2015-01-15
Priority:Low Due date:
Assignee:Maksim Shabunin % 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

Either I am totally misreading the text at http://code.opencv.org/projects/opencv/wiki/CodingStyleGuide#Return-value or there is a typo.

However, in case of image processing function it would lead to often allocation/deallocation of large memory blocks, so the image processing functions don't create and return result images rather than modify an output image, passed as a parameter (by reference).

I suspect that emboldened “than” should be “they.” I would also suggest that it is a run-on sentence and might better be written:

However, in case of image processing function it this would lead to often allocation/deallocation of large memory blocks. so the Instead image processing functions don't create and return result images. Rather than they modify an output image, which is passed in as a parameter (by reference).

History

#1
Updated by Craig Reynolds about 10 years ago

“...would lead to often frequent allocation/deallocation...”

#2
Updated by Maksim Shabunin almost 10 years ago

Fixed:

However, in case of image processing function this would lead to frequent allocation/deallocation of large memory blocks. Image processing functions often modify an output image, which is passed as a parameter (by reference) instead of creating and returning result images.

  • Status changed from New to Done
  • Assignee set to Maksim Shabunin
  • Target version set to 3.0
  • Affected version changed from 2.4.9 (latest release) to branch 'master' (3.0-dev)

Also available in: Atom PDF