Documentation doesn't appear to have any function descriptions about pencil.js HOT 7 CLOSED

Thanks for the report. The documentation is quite new and still far from perfect.

In the example of the Line constructor, there is a description for the points (that is "List of points", which is not that helpful).
I'll try to add informations to all descriptions. In the mean time, could you point me to where you find that it's critically missing informations ?

from pencil.js.

I mean, to be honest, I'd be more than happy to help add descriptions as I'm using the library where I can. If you're okay with me asking questions here, I'll fork the repo and add description the JSDocs as I go.

Also, I don't think the absolute: true flag works for absolute positioning of points in the line. I'm using version 1.18.0 of pencil

Update: absolute flag isn't available in 1.18.0, I'm using 1.18.0 because of #77 but will update to v2.0.0 using npm@7

from pencil.js.

So it seems that a reason some features are not working as expected is because the documentation is related to the master branch, whilst the npm code is based on the latest tag version.

Meaning for example, the absolute flag that is shown in the documentation isn't actually available in v2.0.0 because it's something that's been added afterwards and documented

from pencil.js.

If you're okay with me asking questions here, I'll fork the repo and add description the JSDocs as I go.

I'll be more than happy for you to help me on this. Please, make a PR and submit your suggestion.

So it seems that a reason some features are not working as expected is because the documentation is related to the master branch, whilst the npm code is based on the latest tag version.

You put your finger on something I didn't consider. It's not be a good idea to have the documentation be on master. I'll look into this.

from pencil.js.

It might be better because there's currently an outstanding recommendation to use pencil 1.18.0 if running npm <7, to have documentation that allows you to select the version of pencil you're using. Is there a way to generate documentation for each version tag maybe?

from pencil.js.

Is there a way to generate documentation for each version tag maybe?

That's would be the best solution, but I'm not sure this is possible given my current setup. Pencil.js has 52 releases to this date, and I don't want to build docs for each of them. Maybe only one for each major release.

from pencil.js.

I fixed the documentation building process. Now, it will only update documentation on new Pencil.js versions.
This change will be triggered in the next version landing as soon as webpack/webpack#2933 is resolved.

We still need to work on better explanation in jsdoc. Are you still up to do it ?

from pencil.js.