Skip to content

Conversation

@mbbatukan
Copy link
Contributor

@mbbatukan mbbatukan commented Jun 20, 2025

Description

Please provide a brief description of the changes made in this pull request.
Added missing kwargs to the dmpoption command.

Issue linked

Please mention the issue number or describe the problem this pull request addresses.
It is a very minor fix. Please see the changes and refer to the documentation: https://ansyshelp.ansys.com/public/account/secured?returnurl=/Views/Secured/corp/v242/en/ans_cmd/Hlp_C_DMPOPTION.html

Summary by Sourcery

Add missing rescombfreq and deleopt parameters to the dmpoption command to enable configuring result combination frequency and local file deletion.

Bug Fixes:

  • Include missing rescombfreq and deleopt keyword arguments in the dmpoption method signature.

Documentation:

  • Update the dmpoption docstring to describe the new rescombfreq and deleopt options.

Copilot AI review requested due to automatic review settings June 20, 2025 22:15
@mbbatukan mbbatukan requested a review from a team as a code owner June 20, 2025 22:15
@mbbatukan mbbatukan requested review from clatapie and germa89 June 20, 2025 22:15
@ansys-reviewer-bot
Copy link
Contributor

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

@ansys-reviewer-bot review

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jun 20, 2025

Reviewer's Guide

The PR enhances the existing dmpoption method by introducing two new keyword arguments corresponding to documented options, updating its docstring, and altering the command string builder to pass these parameters.

Class diagram for updated dmpoption method

classDiagram
    class SolutionCommands {
        +dmpoption(filetype="", combine="", rescombfreq="", deleopt="", **kwargs)
    }
Loading

File-Level Changes

Change Details Files
Added missing rescombfreq and deleopt parameters to dmpoption
  • Extended method signature to include rescombfreq and deleopt
  • Inserted detailed docstring entries for rescombfreq and deleopt
  • Adjusted command string to append rescombfreq and deleopt values
src/ansys/mapdl/core/_commands/solution/analysis_options.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

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

The PR adds two missing keyword arguments (rescombfreq, deleopt) to the dmpoption command to align with the official ANSYS documentation.

  • Extended dmpoption signature with rescombfreq and deleopt
  • Updated docstring to describe the new parameters
  • Modified the command string assembly to include the new arguments
Comments suppressed due to low confidence (1)

src/ansys/mapdl/core/_commands/solution/analysis_options.py:1369

  • A comma is missing between {combine} and {rescombfreq}. It should be ...,{combine},{rescombfreq},{deleopt} to correctly separate all arguments.
        command = f"DMPOPTION,{filetype},{combine}{rescombfreq},{deleopt}"

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @mbbatukan - I've reviewed your changes - here's some feedback:

  • The f-string for DMPOPTION is missing a comma between the combine and rescombfreq fields (should be ...,{combine},{rescombfreq},...).
  • Consider adding validation or enum checks for the new kwargs (rescombfreq, deleopt) to restrict them to the supported ANSYS keyword values.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- The f-string for DMPOPTION is missing a comma between the combine and rescombfreq fields (should be `...,{combine},{rescombfreq},...`).
- Consider adding validation or enum checks for the new kwargs (rescombfreq, deleopt) to restrict them to the supported ANSYS keyword values.

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.

Copy link
Collaborator

@germa89 germa89 left a comment

Choose a reason for hiding this comment

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

Hi @mbbatukan! Thanks you a lot for your contribution! It is greatly appreciated! 😄

Since you are trying to merge from a fork, and the forks in GitHub do not have access to the repository secrets needed to run the CICD pipelines, your PR needs to be migrated to another PR within PyMAPDL repository. Do not worry this is an automated process, which the bot and I will perform. If there are any other changes needed in this PR to make the CICD pass, you can make them in that branch or this one, I will take care of syncing both. Ping me if I take too long to reply or show up.

The new PR keeps the commit history, so you will be acknowledged as PyMAPDL contributor even if the migrated PR is made by the bot or myself.

Again, thank you a lot for your contribution! 🚀

@germa89
Copy link
Collaborator

germa89 commented Jun 23, 2025

@pyansys-ci-bot migrate

@pyansys-ci-bot
Copy link
Contributor

❌ Error ❌

An error occurred while migrating or syncing the PR. Pinging @pymapdl-maintainers for assistance.

2 similar comments
@pyansys-ci-bot
Copy link
Contributor

❌ Error ❌

An error occurred while migrating or syncing the PR. Pinging @pymapdl-maintainers for assistance.

@pyansys-ci-bot
Copy link
Contributor

❌ Error ❌

An error occurred while migrating or syncing the PR. Pinging @pymapdl-maintainers for assistance.

@germa89
Copy link
Collaborator

germa89 commented Jun 23, 2025

🚀 Migration completed!

The PR #4030 has been created successfully.

Thank you @mbbatukan for your contribution! Please review the PR and make any necessary changes.

git clone -b migration/pr-4027 --single-branch https://github.com/ansys/pymapdl.git

If you have GitHub CLI installed, you can also use the following command to check out the pull request:

gh pr checkout https://github.com/ansys/pymapdl/pull/4030

This PR will be closed by the admins when the new PR has been checked to work.

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