Skip to content

docs: docs updated & minor fixes - #5374

Merged
mayankansys merged 6 commits into
mainfrom
docs/updated_docs_4946
Sep 9, 2026
Merged

mayankansys merged 6 commits into
mainfrom
docs/updated_docs_4946

Conversation

@mayankansys

@mayankansys mayankansys commented Sep 4, 2026 •

Copy link
Copy Markdown
Collaborator

Context

Several user guide docs still showed outdated usage patterns like launch_fluent()/mode=pyfluent.FluentMode.*, deprecated arguments (user_docker_compose), and a few incorrect code references, as flagged in #4946.

Change Summary

  • Replaced launch_fluent()/connect_to_fluent() examples across user guide pages with the modern Solver.from_install(), Meshing.from_install(), PureMeshing.from_install(), and Solver.from_container() session class methods.
  • Fixed deprecated/incorrect keyword arguments.

Rationale

Aligns documentation with the current recommended PyFluent API surface and establishes reusable, explicit criteria

Impact

Affects only documentation — no functional/code changes.

@github-actions github-actions Bot added documentation Documentation related (improving, adding, etc) maintenance General maintenance of the repo (libraries, cicd, etc) CI/CD labels Sep 4, 2026
@codacy-production

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@mayankansys mayankansys changed the title API docs updated & minor fixes docs: API docs updated & minor fixes Sep 7, 2026
@mayankansys mayankansys linked an issue Sep 8, 2026 that may be closed by this pull request
@mayankansys mayankansys changed the title docs: API docs updated & minor fixes docs: docs updated & minor fixes Sep 8, 2026
@mayankansys
mayankansys marked this pull request as ready for review September 9, 2026 07:03
@mayankansys
mayankansys requested review from hpohekar, mkundu1, prmukherj and seanpearsonuk and removed request for seanpearsonuk September 9, 2026 07:03

@seanpearsonuk seanpearsonuk left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good

Comment thread doc/source/user_guide/transfer_data.rst
@prmukherj

Copy link
Copy Markdown
Collaborator

@mayankansys, please do check if there are other things that can be updated as well by skimming the docs once before resolving the task. Thank you.

@mayankansys

Copy link
Copy Markdown
Collaborator Author

@mayankansys, please do check if there are other things that can be updated as well by skimming the docs once before resolving the task. Thank you.

Sure. I'll double check all the docs once again while resolving this issue.

@mayankansys
mayankansys merged commit 6ba200b into main Sep 9, 2026
53 of 72 checks passed
@mayankansys
mayankansys deleted the docs/updated_docs_4946 branch September 9, 2026 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI/CD documentation Documentation related (improving, adding, etc) maintenance General maintenance of the repo (libraries, cicd, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automatically clean up user guide & other docs

4 participants