Empathy List Archives

W

wolf

Fri, Mar 18, 2016 7:17 AM

Issue fixed - thank you all.

While on fixing the manual, let me point out two other issues that are
likely to cause head scratching.

The OpenSCAD manual describes the capabilities of a command in a form that
looks like the fragment of an example. This is a good thing, as it makes
reading the manual a lot easier as, e.g., the average Linux man-page. For
DXF extrusion, such an example is given, but it is not complete. Shouldn't
there be a reference/link outlining that a full description is given
elsewhere? That I am not misunderstood: I like idea of giving a piece of
sample code. But also: do people arriving at this piece of code know that
some [optional] parameters have been omitted?

Second issue,
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem
Under
"Extruding a Polygon

Extrusion can also be performed on polygons with points chosen by the user.

Here is a simple polygon and its (fine-grained: $fn=200) rotational
extrusion (/profile and lathe/)." I have issues with the English used,
specifically the portion in italics. To my understanding, a lathe is a
machine to produce parts with rotational symmetry, and not a part that has
rotational symmetry. Can't the piece of text be replaced with (/before and
after rotation/)? Italics again added for emphasis.

wolf

--
View this message in context: http://forum.openscad.org/conflicting-manual-entries-tp16467p16530.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

Issue fixed - thank you all. While on fixing the manual, let me point out two other issues that are likely to cause head scratching. The OpenSCAD manual describes the capabilities of a command in a form that looks like the fragment of an example. This is a good thing, as it makes reading the manual a lot easier as, e.g., the average Linux man-page. For DXF extrusion, such an example is given, but it is not complete. Shouldn't there be a reference/link outlining that a full description is given elsewhere? That I am not misunderstood: I like idea of giving a piece of sample code. But also: do people arriving at this piece of code know that some [optional] parameters have been omitted? Second issue, https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem Under "*Extruding a Polygon* Extrusion can also be performed on polygons with points chosen by the user. Here is a simple polygon and its (fine-grained: $fn=200) rotational extrusion (/profile and lathe/)." I have issues with the English used, specifically the portion in italics. To my understanding, a lathe is a machine to produce parts with rotational symmetry, and not a part that has rotational symmetry. Can't the piece of text be replaced with (/before and after rotation/)? Italics again added for emphasis. wolf -- View this message in context: http://forum.openscad.org/conflicting-manual-entries-tp16467p16530.html Sent from the OpenSCAD mailing list archive at Nabble.com.

NH

nop head

Fri, Mar 18, 2016 9:13 AM

I think simply removing the text in brackets is clearer.

Here is a simple polygon and its (fine-grained: $fn=200) rotational

extrusion.

On 18 March 2016 at 07:17, wolf wv99999@gmail.com wrote:

Issue fixed - thank you all.

While on fixing the manual, let me point out two other issues that are
likely to cause head scratching.

The OpenSCAD manual describes the capabilities of a command in a form that
looks like the fragment of an example. This is a good thing, as it makes
reading the manual a lot easier as, e.g., the average Linux man-page. For
DXF extrusion, such an example is given, but it is not complete. Shouldn't
there be a reference/link outlining that a full description is given
elsewhere? That I am not misunderstood: I like idea of giving a piece of
sample code. But also: do people arriving at this piece of code know that
some [optional] parameters have been omitted?

Second issue,
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem
Under
"Extruding a Polygon

Extrusion can also be performed on polygons with points chosen by the user.

Here is a simple polygon and its (fine-grained: $fn=200) rotational
extrusion (/profile and lathe/)." I have issues with the English used,
specifically the portion in italics. To my understanding, a lathe is a
machine to produce parts with rotational symmetry, and not a part that has
rotational symmetry. Can't the piece of text be replaced with (/before and
after rotation/)? Italics again added for emphasis.

wolf

--
View this message in context:
http://forum.openscad.org/conflicting-manual-entries-tp16467p16530.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

OpenSCAD mailing list
Discuss@lists.openscad.org
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org

I think simply removing the text in brackets is clearer. Here is a simple polygon and its (fine-grained: $fn=200) rotational > extrusion. > On 18 March 2016 at 07:17, wolf <wv99999@gmail.com> wrote: > Issue fixed - thank you all. > > While on fixing the manual, let me point out two other issues that are > likely to cause head scratching. > > The OpenSCAD manual describes the capabilities of a command in a form that > looks like the fragment of an example. This is a good thing, as it makes > reading the manual a lot easier as, e.g., the average Linux man-page. For > DXF extrusion, such an example is given, but it is not complete. Shouldn't > there be a reference/link outlining that a full description is given > elsewhere? That I am not misunderstood: I like idea of giving a piece of > sample code. But also: do people arriving at this piece of code know that > some [optional] parameters have been omitted? > > Second issue, > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem > Under > "*Extruding a Polygon* > > Extrusion can also be performed on polygons with points chosen by the user. > > Here is a simple polygon and its (fine-grained: $fn=200) rotational > extrusion (/profile and lathe/)." I have issues with the English used, > specifically the portion in italics. To my understanding, a lathe is a > machine to produce parts with rotational symmetry, and not a part that has > rotational symmetry. Can't the piece of text be replaced with (/before and > after rotation/)? Italics again added for emphasis. > > wolf > > > > -- > View this message in context: > http://forum.openscad.org/conflicting-manual-entries-tp16467p16530.html > Sent from the OpenSCAD mailing list archive at Nabble.com. > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org >

DM

doug moen

Fri, Mar 18, 2016 2:44 PM

Wolf:

I fixed the first issue with DXF Extrusion last night. There is now a
see also link
I rewrote the sentence with the unclear wording in Extruding a Polygon.

On 18 March 2016 at 03:17, wolf wv99999@gmail.com wrote:

Issue fixed - thank you all.

While on fixing the manual, let me point out two other issues that are
likely to cause head scratching.

The OpenSCAD manual describes the capabilities of a command in a form that
looks like the fragment of an example. This is a good thing, as it makes
reading the manual a lot easier as, e.g., the average Linux man-page. For
DXF extrusion, such an example is given, but it is not complete. Shouldn't
there be a reference/link outlining that a full description is given
elsewhere? That I am not misunderstood: I like idea of giving a piece of
sample code. But also: do people arriving at this piece of code know that
some [optional] parameters have been omitted?

Second issue,
https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem
Under
"Extruding a Polygon

Extrusion can also be performed on polygons with points chosen by the user.

Here is a simple polygon and its (fine-grained: $fn=200) rotational
extrusion (/profile and lathe/)." I have issues with the English used,
specifically the portion in italics. To my understanding, a lathe is a
machine to produce parts with rotational symmetry, and not a part that has
rotational symmetry. Can't the piece of text be replaced with (/before and
after rotation/)? Italics again added for emphasis.

wolf

--
View this message in context:
http://forum.openscad.org/conflicting-manual-entries-tp16467p16530.html
Sent from the OpenSCAD mailing list archive at Nabble.com.

OpenSCAD mailing list
Discuss@lists.openscad.org
http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org

Wolf: 1. I fixed the first issue with DXF Extrusion last night. There is now a see also link 2. I rewrote the sentence with the unclear wording in Extruding a Polygon. On 18 March 2016 at 03:17, wolf <wv99999@gmail.com> wrote: > Issue fixed - thank you all. > > While on fixing the manual, let me point out two other issues that are > likely to cause head scratching. > > The OpenSCAD manual describes the capabilities of a command in a form that > looks like the fragment of an example. This is a good thing, as it makes > reading the manual a lot easier as, e.g., the average Linux man-page. For > DXF extrusion, such an example is given, but it is not complete. Shouldn't > there be a reference/link outlining that a full description is given > elsewhere? That I am not misunderstood: I like idea of giving a piece of > sample code. But also: do people arriving at this piece of code know that > some [optional] parameters have been omitted? > > Second issue, > https://en.wikibooks.org/wiki/OpenSCAD_User_Manual/Using_the_2D_Subsystem > Under > "*Extruding a Polygon* > > Extrusion can also be performed on polygons with points chosen by the user. > > Here is a simple polygon and its (fine-grained: $fn=200) rotational > extrusion (/profile and lathe/)." I have issues with the English used, > specifically the portion in italics. To my understanding, a lathe is a > machine to produce parts with rotational symmetry, and not a part that has > rotational symmetry. Can't the piece of text be replaced with (/before and > after rotation/)? Italics again added for emphasis. > > wolf > > > > -- > View this message in context: > http://forum.openscad.org/conflicting-manual-entries-tp16467p16530.html > Sent from the OpenSCAD mailing list archive at Nabble.com. > > _______________________________________________ > OpenSCAD mailing list > Discuss@lists.openscad.org > http://lists.openscad.org/mailman/listinfo/discuss_lists.openscad.org > > >

discuss@lists.openscad.org

conflicting manual entries