Fixed position of documentation.js '//addToMap' tag

[stebogit]

Ref. Turf-www #113

Updated @examples doc for updating the website

[rowanwins]

If you can keep the properties below the //addToMap that would be my preference :)

[rowanwins]

so rather than moving the curved.properties above the //addToMap tag, I generally move it to below the var addToMap = [line, curved]. That benefit of that is that it isn't rendered as part of the code sample (which might potentially confuse people)

So I'd make it look like

  * var curved = turf.bezier(line);
   *
   * //addToMap
   * var addToMap = [line, curved];
   * curved.properties = { stroke: '#0f0' };
   */

[DenisCarriere]

👍 Agreed, so anything that's below//addToMap is not displayed in the website.

[stebogit]

will do! 👍

[stebogit]

@DenisCarriere @rowanwins ok the code after addToMap = ... is not rendered in the map on the website. So what's the purpose of adding properties in the example, which highlight the result on the map, if they are not actually used for the map?

[DenisCarriere]

There's two parts, the map which uses the addToMap as a featureCollection with all the properties. The second is the JSDocs example being rendered on the website which does not include the addToMap details.
Most of the extra properties added is to properly visualize the map example.

Hopefully that helps answer your question

[DenisCarriere]

Just pushed the latest @example tests to this PR, we should be able to detect those JSDocs example errors a lot easier now.

[DenisCarriere]

Ok fixed most of the major @example errors.

I've excluded some of the new modules (6 skipped) from the tests since they haven't been added to @turf/turf yet.

$ tap test.example.js
test.example.js ................................... 100/106
  Skipped: 6
    clustersDbscan
    clustersKmeans
    getCluster
    clusterEach
    clusterReduce
    interpolate

total ............................................. 100/106

  100 passing (1s)
  6 pending

[DenisCarriere]

@rowanwins 👍 Updated the addToMap JSDocs.