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

docs: add examples on new methods #1089

Merged
merged 20 commits into from
Apr 10, 2024
Merged

Conversation

dastan-ansys
Copy link
Contributor

@dastan-ansys dastan-ansys commented Apr 1, 2024

Description

Added example notebooks for scale, map, and mirror functions as well as sweep sketch (also known as sweep profile) and sweep chain.

Issue linked

1049

Checklist

  • I have tested my changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have followed the coding style guidelines of this project.
  • I have added appropriate unit tests.
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved to the PR if any.
  • I have assigned this PR to myself.
  • I have added the minimum version decorator to any new backend method implemented.
  • I have made sure that the title of my PR follows Conventional commits style (e.g. feat: extrude circle to cylinder)

@dastan-ansys dastan-ansys self-assigned this Apr 1, 2024
@dastan-ansys dastan-ansys requested review from PipKat and a team as code owners April 1, 2024 11:00
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 1, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 1, 2024
@RobPasMue RobPasMue changed the title Docs/add examples on new methods docs: add examples on new methods Apr 1, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 1, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 1, 2024
@codecov-commenter
Copy link

codecov-commenter commented Apr 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.23%. Comparing base (7b69752) to head (4d340a1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1089   +/-   ##
=======================================
  Coverage   90.23%   90.23%           
=======================================
  Files          93       93           
  Lines        6839     6839           
=======================================
  Hits         6171     6171           
  Misses        668      668           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@RobPasMue
Copy link
Member

Looks like the examples are missing some basic objects - see https://github.com/ansys/pyansys-geometry/actions/runs/8507282654/job/23298884789?pr=1089#step:11:2509

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 2, 2024
RobPasMue and others added 2 commits April 10, 2024 11:53
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 10, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 10, 2024
@RobPasMue
Copy link
Member

Working on this to get it running and merged

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 10, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 10, 2024
@github-actions github-actions bot added documentation Improvements or additions to documentation and removed documentation Improvements or additions to documentation labels Apr 10, 2024
@RobPasMue RobPasMue enabled auto-merge (squash) April 10, 2024 13:42
@RobPasMue
Copy link
Member

Thanks a lot for the examples @dastan-ansys!

@RobPasMue RobPasMue merged commit c2c382f into main Apr 10, 2024
40 checks passed
@RobPasMue RobPasMue deleted the docs/add-examples-on-new-methods branch April 10, 2024 14:08
@RobPasMue RobPasMue linked an issue Apr 10, 2024 that may be closed by this pull request
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add examples on new methods
6 participants