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

Doc fixes (add wedge) #844

Merged
merged 6 commits into from
Nov 18, 2021
Merged

Doc fixes (add wedge) #844

merged 6 commits into from
Nov 18, 2021

Conversation

revolter
Copy link
Contributor

No description provided.

@codecov
Copy link

codecov bot commented Aug 15, 2021

Codecov Report

Merging #844 (631b4ef) into master (cd0c81e) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #844   +/-   ##
=======================================
  Coverage   96.11%   96.11%           
=======================================
  Files          39       39           
  Lines        9130     9130           
  Branches     1017     1017           
=======================================
  Hits         8775     8775           
  Misses        206      206           
  Partials      149      149           
Impacted Files Coverage Δ
cadquery/cq.py 91.76% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cd0c81e...631b4ef. Read the comment docs.

@jmwright
Copy link
Member

@revolter Why did you remove the mention of the wedge primitive?

Wedge:

def wedge(

@revolter
Copy link
Contributor Author

Because that section has

See 3-d Operations to learn more.

at the end, which links to https://cadquery.readthedocs.io/en/latest/apireference.html#id1, which doesn't mention wedges nor cylinders.

@jmwright
Copy link
Member

Ok, so we'll need to add the missing a reference to wedge under 3-d Operations at some point.

@revolter
Copy link
Contributor Author

Is it a complicated task? Also, what about cylinder?

@jmwright
Copy link
Member

Is it a complicated task?

No, you can just add it below Workplane.sphere under the autosummary here.

Also, what about cylinder?

I did a search to confirm and there is no analogous method for Workplane.cylinder.

@revolter revolter changed the title Remove examples that don't exist in linked table Remove cylinder mention that doesn't exist in the linked table Aug 18, 2021
@jmwright
Copy link
Member

Like this?

Yes, that looks correct to me.

Looks like we're going to have to correct a mypy issue that's probably caused by the update to OCP 7.5.2. I'll try to get to that today or tomorrow.

@jmwright
Copy link
Member

@adam-urbanczyk I think it may be the missing OCP 7.5.2 stubs that are keeping mypy from passing in these tests. Could you confirm when you are available?

@jmwright
Copy link
Member

@revolter Assuming that #858 gets merged, that will negate the need to remove the mention of the cylinder primitive in this PR.

@revolter
Copy link
Contributor Author

Oh, wow, amazing ❤️ We'll wait for it to get merged, if it's ok, and then I'll update the title and content of this one.

@adam-urbanczyk adam-urbanczyk changed the title Remove cylinder mention that doesn't exist in the linked table Doc fixes (add wedge) Nov 18, 2021
Copy link
Member

@jmwright jmwright left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @revolter !

@jmwright jmwright merged commit 2b08071 into CadQuery:master Nov 18, 2021
@revolter
Copy link
Contributor Author

And thank you @adam-urbanczyk for updating my PR 😃

@revolter revolter deleted the patch-2 branch November 18, 2021 12:32
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 this pull request may close these issues.

3 participants