Skip to content

fix: typo in post - #4036

Merged
germa89 merged 2 commits into
mainfrom
doc/fix-typo
Jun 25, 2025
Merged

germa89 merged 2 commits into
mainfrom
doc/fix-typo

Conversation

@germa89

@germa89 germa89 commented Jun 25, 2025 •

Copy link
Copy Markdown
Collaborator

Description

As the title.

Issue linked

Related to #1300

Checklist

Summary by Sourcery

Documentation:

  • Corrected 'Equilvanent' to 'Equivalent' in various result method docstrings in post.py

@germa89
germa89 requested a review from a team as a code owner June 25, 2025 11:24
@ansys-reviewer-bot

Copy link
Copy Markdown
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@sourcery-ai

sourcery-ai Bot commented Jun 25, 2025 •

Copy link
Copy Markdown
Contributor

Reviewer's Guide

This PR fixes a recurring typo in post.py by replacing the misspelled “Equilvanent” with the correct “Equivalent” in the docstrings for various result-reporting methods.

File-Level Changes

Change Details Files
Correct spelling of “Equilvanent” to “Equivalent” in docstrings
  • Fixed docstrings for nodal result getters (temperature, displacement, rotation, pressure, voltage, stresses)
  • Fixed docstrings for element result getters (displacement, stress, temperature)
  • Fixed docstrings for strain-related getters (total component/principal/strain intensity/equivalent)
src/ansys/mapdl/core/post.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Hey @germa89 - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions github-actions Bot added the bug Issue, problem or error in PyMAPDL label Jun 25, 2025
@germa89

germa89 commented Jun 25, 2025

Copy link
Copy Markdown
Collaborator Author

@pyansys-ci-bot LGTM.

@germa89
germa89 enabled auto-merge (squash) June 25, 2025 11:31
@germa89 germa89 self-assigned this Jun 25, 2025

@pyansys-ci-bot pyansys-ci-bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

✅ Approving this PR because germa89 said so in here 😬

LGTM

@codecov

codecov Bot commented Jun 25, 2025 •

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.17%. Comparing base (53ad87c) to head (1b249f3).
Report is 5 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4036      +/-   ##
==========================================
+ Coverage   89.05%   89.17%   +0.12%     
==========================================
  Files         187      187              
  Lines       14970    14970              
==========================================
+ Hits        13331    13349      +18     
+ Misses       1639     1621      -18     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89
germa89 merged commit 298fbe7 into main Jun 25, 2025
@germa89
germa89 deleted the doc/fix-typo branch June 25, 2025 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Issue, problem or error in PyMAPDL

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants