docs: Upgrade cheat sheet. [skip tests] #4640
Conversation
github-actions
bot
added
the
documentation
I like point 2. If we can maximse use of |
|
I have just mentioned to @mayankansys that wherever a comment is removed, a blank line should be retained in its place. This applies to all sections, including meshing workflow. |
…fluent into docs/upgrade_cheatsheet
There was a problem hiding this comment.
Pull request overview
This PR updates the PyFluent cheat sheet documentation to provide a more streamlined and modernized reference guide.
Changes:
- Restructured the cheat sheet into focused sections (Quick Start, Session Management, Meshing Workflow, Physics Setup, Solution, Post-Processing)
- Simplified code examples to use modern PyFluent APIs with shorter, more practical snippets
- Added imports section demonstrating the use of
ansys.units.VariableCatalogfor field references
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| doc/source/cheatsheet/cheat_sheet.qmd | Comprehensive reorganization and modernization of the cheat sheet with condensed examples and improved structure |
| doc/changelog.d/4640.documentation.md | Added changelog entry for the cheat sheet upgrade |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Context
What was the situation or problem before this change?
Change Summary
What changes were made?
Rationale
Why was this approach taken?
Impact
What parts of the system or workflows are affected?