Docs: Add Curve Pen Documentation
AbandonedPublic
Actions

Authored by Dilith Jayakody (dilithjay) on May 31 2022, 6:11 AM.

Details

Reviewers

Hans Goudey (HooglyBoogly)
Aaron Carlisle (Blendify)

Summary

This revision adds the documentation for the Curve Pen tool.

Diff Detail

Event Timeline

Dilith Jayakody (dilithjay) requested review of this revision.May 31 2022, 6:11 AM

Dilith Jayakody (dilithjay) created this revision.

Dilith Jayakody (dilithjay) added a reviewer: Aaron Carlisle (Blendify).May 31 2022, 6:13 AM

Thanks for working on this. I have some suggestions about a few more details to add, and a few smaller changes.

Generally I think a bit more user-level information would be helpful, i.e. why specific features are useful, what is their purpose, how can they be used with the other features, etc.
The manual isn't supposed to be a full guide or tutorial, but this manual page is currently pretty bare, especially for a relatively complex tool.
I don't think any of that is blocking though, because it's just nice to have any manual page at all.

Also, the maximum line length for the manual is 120 characters.

manual/modeling/curves/tools/pen.rst
29	Suggestion: `The type of the handles of the` -> The :ref:`handle type <curve-bezier-handle-type>` used for the
38	This is a bit vague: `Drag on a segment in between two control points to adjust the handles, changing the shape of the curve without affecting the location of any control points.`
47	This should explain what happens in different words (rather than reusing the name), i.e. "Make the spline cyclic" or something. Generally a bit more detail is helpful.
63	I think the "Middle Point" is just a control point-- the other points are handles
72	`vertex` -> `control point`
75	Typo/grammar mistake here
81	Suggestion: `Limit the movement of the handle to its current direction, so only its length can be adjusted.`