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

Correct formatting of cboreHole(), cskHole(), and hole() example code #1062

Merged

Conversation

sethfischer
Copy link
Contributor

@sethfischer sethfischer commented Apr 25, 2022

Correct formatting of code block.

See https://cadquery.readthedocs.io/en/latest/classreference.html?highlight=cboreHole#cadquery.Workplane.cboreHole which is rendered on a single line with superfluous horizontal whitespace.

@codecov
Copy link

codecov bot commented Apr 25, 2022

Codecov Report

Merging #1062 (2eebfe9) into master (9745762) will not change coverage.
The diff coverage is n/a.

❗ Current head 2eebfe9 differs from pull request most recent head 4bbf8a5. Consider uploading reports for the commit 4bbf8a5 to get more accurate results

@@           Coverage Diff           @@
##           master    #1062   +/-   ##
=======================================
  Coverage   96.34%   96.34%           
=======================================
  Files          40       40           
  Lines        9533     9533           
  Branches     1259     1259           
=======================================
  Hits         9185     9185           
  Misses        205      205           
  Partials      143      143           
Impacted Files Coverage Δ
cadquery/cq.py 92.43% <ø> (ø)

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

@sethfischer sethfischer force-pushed the docs-format-cborehole-example branch from 6e3a567 to b22e4f7 Compare April 28, 2022 20:46
@jmwright
Copy link
Member

@sethfischer Unless you wrap everything after the assignment = in parentheses, I think you'll still need the line continuation characters.

@sethfischer sethfischer force-pushed the docs-format-cborehole-example branch from b22e4f7 to 9210072 Compare May 1, 2022 10:23
@sethfischer
Copy link
Contributor Author

Amended to escape line continuation character which results in a correctly rendered code block. The same correction was made in cskHole() and hole().

Also completed a truncated comment for cboreHole() to match cskHole() and hole().

@sethfischer sethfischer force-pushed the docs-format-cborehole-example branch from 9210072 to 5ade06d Compare May 2, 2022 21:26
@sethfischer sethfischer changed the title Correct format of cboreHole() example code Correct formating of cboreHole(), cskHole(), and hole() example code May 2, 2022
@sethfischer sethfischer changed the title Correct formating of cboreHole(), cskHole(), and hole() example code Correct formatting of cboreHole(), cskHole(), and hole() example code May 2, 2022
Copy link
Member

@lorenzncode lorenzncode left a comment

Choose a reason for hiding this comment

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

I'd suggest to format these with black to be consistent with the other examples and also remove Plane.XY().

@sethfischer sethfischer force-pushed the docs-format-cborehole-example branch 2 times, most recently from affde13 to 72fe298 Compare June 1, 2022 09:42
 * Format with Black.
 * Complete truncated comment.
@sethfischer sethfischer force-pushed the docs-format-cborehole-example branch from 72fe298 to 4bbf8a5 Compare June 1, 2022 10:26
@jmwright jmwright self-requested a review June 1, 2022 12:43
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.

With the latest changes it looks good to me, and all the checks pass. Thanks @sethfischer

@lorenzncode Once you confirm that it looks good to you, please feel free to merge.

Copy link
Member

@lorenzncode lorenzncode left a comment

Choose a reason for hiding this comment

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

Thanks @sethfischer.

@lorenzncode lorenzncode merged commit 2f5caf2 into CadQuery:master Jun 2, 2022
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.

3 participants