Geometry Boost List: Re: [geometry] Boost.Geometry contribution tutorial

Subject: Re: [geometry] Boost.Geometry contribution tutorial
From: Adam Wulkiewicz (adam.wulkiewicz_at_[hidden])
Date: 2014-05-24 16:55:51

Hi,

Barend Gehrels wrote:
> Adam Wulkiewicz wrote On 22-5-2014 13:16:
>> Do we also want to put developers guidelines and/or GitHub tutorial 
>> in the docs (which means putting the images somewhere in docs) or 
>> should they stay only in the Wiki (which means creating an empty 
>> branch 'wiki' and putting the images there)?
>>
>> I'd probably vote for option 2. Plus adding direct links to 
>> Guidelines and Contribution Tutorial in the README.
>
> Yes, I agree. The documentation (Quickbook) is targetted to end users. 
> Having direct links is OK. But we don't need them in two places, 
> w.r.t. maintenance.
>
> Can you put one thing more in the Guidelines, in the free function 
> please add the concept check with the comment that it should be done 
> as early as possible?
> template  <typename  Point>
> inline  int  foo(Point  const&  point)
> {
>      // Checking if the geometry type fulfils the concept should be done as early as possible, so in the first entry point
>      concept::check<Point const>();
>
>       return  dispatch<Point>::apply(point);
> }

Done.

And the tutorial is now on Wiki too:
https://github.com/boostorg/geometry/wiki/Contribution-Tutorial

Regards,
Adam