Hi, Francois, Thanks for contributing to Worg!
Francois Polito <[email protected]> writes: > I'll prepare a revised version of the patch addressing all these > points. Would you like me to resubmit it once the corrections are > made? Please do! A couple of stylistic suggestions in addition to Ihor's points: For consistency with other Babel docs, please have a look at how the opening "banner" is implemented e.g. in ob-doc-asymptote.org. In "Introduction": through babel code blocks -> through Babel source code blocks Please capitalize "Babel" throughout for consistency (except in code references like "org-babel", of course). The documentation varies a bit as to what source code blocks are called (source blocks, code blocks, ...), so it's good to use all the words at the beginning. parametric design making it ideal for technical parts -> parametric design, making it ideal for technical parts ^^^^ comma After that, I think "babel" could be replaced with "code blocks" or similar here: OpenSCAD babel supports -> OpenSCAD source blocks support Under "Header Arguments", please indicate the defaults for :results and :exports, and whether any headers are required (I presume :file is)? (I realize that this may seem redundant, given what you write in the other sections, but it's good to have consistency here.) Under "Result Types", it seems a bit over-structured to have a "Supported by Babel" subheading and a single bullet point. I suggest removing both and just using normal prose, something like: OpenSCAD produces model files (stl, ...) and image files (svg, png, ...) ... Same for "Differences": I'd drop the subheading "Not Directly Supported" and just go with something like *Console output* ... is not directly supported, but you can use a shell wrapper ... Regards, Christian
