docs: Update outdated field_info docs [skip tests] #4257
+32
−31
Conversation
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
prmukherj
requested review from
mkundu1,
seanpearsonuk and
hpohekar
as code owners
github-actions
bot
added
the
documentation
mkundu1
reviewed
Jul 9, 2025
|
|
||
| .. code-block:: python | ||
| >>> field_info.get_range("velocity") | ||
| >>> field_info.get_scalar_field_range("velocity") |
There was a problem hiding this comment.
This example is bit misleading, velocity is not a scalar field in Fluent and also the empty range output is not very compelling. We can keep just the cell-weight example.
mkundu1
approved these changes
Jul 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR refines the .rst documentation for accessing field info in PyFluent. It includes improved grammar, consistent formatting, and clearer explanations for retrieving scalar and vector field metadata from a Fluent session.
Corrected "get_range" -> "get_scalar_field_range"