Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Workplane.sweep documentation cleanup #498

Closed
trayracing opened this issue Nov 9, 2020 · 1 comment · Fixed by #496
Closed

Workplane.sweep documentation cleanup #498

trayracing opened this issue Nov 9, 2020 · 1 comment · Fixed by #496
Labels

Comments

@trayracing
Copy link

Workplane.sweep documentation could use a bit of tweaking:

  1. The implication of multisection is not described.
  2. Unclear why sweepAlongWires is optional[bool] instead of bool.
  3. Only 5 of 8 parameters have descriptions in cq.py.
  4. The generated documentation repeats some parameters in a mangled fashion at
    For example, clean occurs twice, once with explanation
@adam-urbanczyk
Copy link
Member

The docstrings are there - it is an issue of docs generation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants