placeSketch method is missing from the API Reference

CadQuery / cadquery

A python parametric CAD scripting framework based on OCCT

https://cadquery.readthedocs.io

Other

2.95k stars 276 forks source link

placeSketch method is missing from the API Reference #1052

Closed GandalfDG closed 2 years ago

GandalfDG commented 2 years ago

While browsing the documentation I was unable to find any mention of the placeSketch method, other than in an example under the sketch documentation page here: Sketch/workplane integration It was difficult to discover as a new user, and once I knew it existed, not being able to find it in the API Reference was an issue.

jmwright commented 2 years ago

The ReadTheDocs search turns up multiple mentions, including in the class summary. Is that not what you were looking for?

GandalfDG commented 2 years ago

The search works if you know what you're looking for, but it was difficult to discover that function, which feels like an important one that bridges between the Workplane and Sketch methods of construction. I think it would make sense to have it listed in the Workplane section on this page: API Reference