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

added docs on the CQ API layers #917

Merged
merged 4 commits into from
Nov 16, 2021

Conversation

Jojain
Copy link
Contributor

@Jojain Jojain commented Nov 6, 2021

As invoked with #909

This PR aims to bring more documentation about the different CadQuery APIs and how one can take advantage of them.

This has been written with my own understanding prism so it is rather subjective. I'm not sure these concepts have been properly named before so this is an attempt to clarify things for eveybody

As invoked with CadQuery#909

This PR aims to bring more documentation about the different CadQuery APIs and how one can take advantage of them.

This has been written with my own understanding prism so it is rather subjective.  I'm not sure these concepts have been properly named before so this is an attempt to clarify things for eveybody
@codecov
Copy link

codecov bot commented Nov 6, 2021

Codecov Report

Merging #917 (f4fef66) into master (930ceb9) will increase coverage by 0.16%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #917      +/-   ##
==========================================
+ Coverage   95.94%   96.11%   +0.16%     
==========================================
  Files          32       39       +7     
  Lines        7825     9127    +1302     
  Branches      846     1017     +171     
==========================================
+ Hits         7508     8772    +1264     
- Misses        184      206      +22     
- Partials      133      149      +16     
Impacted Files Coverage Δ
cadquery/occ_impl/shapes.py 92.52% <0.00%> (-0.18%) ⬇️
cadquery/occ_impl/solver.py 94.28% <0.00%> (-0.05%) ⬇️
cadquery/__init__.py 100.00% <0.00%> (ø)
tests/test_assembly.py 100.00% <0.00%> (ø)
cadquery/occ_impl/exporters/assembly.py 100.00% <0.00%> (ø)
cadquery/occ_impl/importers.py
tests/test_hull.py 100.00% <0.00%> (ø)
cadquery/occ_impl/importers/__init__.py 94.28% <0.00%> (ø)
tests/test_sketch.py 100.00% <0.00%> (ø)
cadquery/occ_impl/importers/dxf.py 87.09% <0.00%> (ø)
... and 9 more

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 930ceb9...f4fef66. Read the comment docs.

@Jojain Jojain changed the title added docs on the CQ different APIs added docs on the CQ API layers Nov 7, 2021
doc/primer.rst Outdated Show resolved Hide resolved
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 @Jojain

doc/primer.rst Outdated Show resolved Hide resolved
Co-authored-by: Jeremy Wright <wrightjmf@gmail.com>
Co-authored-by: Marcus Boyd <mwb@geosol.com.au>
@adam-urbanczyk adam-urbanczyk merged commit e91714d into CadQuery:master Nov 16, 2021
@adam-urbanczyk
Copy link
Member

Thanks for the contribution @Jojain !

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

Successfully merging this pull request may close these issues.

4 participants