docs: docstrings fix 4920 - #5230
Merged
Merged
Conversation
….com/ansys/pyfluent into refactor/couple_issues_launch_fluent
….com/ansys/pyfluent into refactor/couple_issues_launch_fluent
…ournal_file condition
….com/ansys/pyfluent into refactor/couple_issues_launch_fluent
Noted merge it
github-actions
Bot
added
the
documentation
Up to standards ✅🟢 Issues
|
mayankansys
marked this pull request as ready for review
July 8, 2026 20:58
seanpearsonuk
approved these changes
Jul 9, 2026
mkundu1
reviewed
Jul 10, 2026
Co-authored-by: Mainak Kundu <94432368+mkundu1@users.noreply.github.com>
prmukherj
reviewed
Jul 13, 2026
mayankansys
commented
Jul 13, 2026
mayankansys
commented
Jul 13, 2026
prmukherj
approved these changes
Jul 13, 2026
mayankansys
enabled auto-merge (squash)
July 13, 2026 18:06
mkundu1
approved these changes
Jul 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
The launcher docstrings were unclear about a required setting. Users were not clearly told they must use either
certificates_folderorinsecure_modefor remote launches.Change Summary
This PR updates the docstrings in the container and slurm launcher classes. It explains the requirement more clearly, notes that the two options are mutually exclusive, and adds the related
ValueErrordetails.Impact
This only affects documentation/docstrings for the launcher APIs. It helps users understand how to configure remote Fluent launches correctly.