Skip to content

Commit 25e2295

Browse files
committed
More doc edits.
1 parent ce1fb4a commit 25e2295

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/Infrastructure/FieldBundle/src/ESMF_FieldBundle.cppF90

+5-5
Original file line numberDiff line numberDiff line change
@@ -2184,7 +2184,7 @@ msg="This call does not work with packed FieldBundle.",&
21842184
^undef ESMF_METHOD
21852185
^define ESMF_METHOD "ESMF_FieldBundleGetIndex()"
21862186
!BOP
2187-
! !IROUTINE: ESMF_FieldBundleGet - Access the fieldIndex-th Field in FieldBundle
2187+
! !IROUTINE: ESMF_FieldBundleGet - Access the Field at a specific index in a FieldBundle
21882188
!
21892189
! !INTERFACE:
21902190
! Private name; call using ESMF_FieldBundleGet()
@@ -2199,15 +2199,15 @@ type(ESMF_KeywordEnforcer), optional:: keywordEnforcer ! must use keywords below
21992199
integer, intent(out), optional :: rc
22002200
!
22012201
! !DESCRIPTION:
2202-
! Get the fieldIndex-th Field in FieldBundle. The order of the Field in FieldBundle
2203-
! is not guranteed. If this call is used iteratively, then any Add, Replace, Remove
2204-
! call on the FieldBundle will invalidate the order of the Field in the FieldBundle.
2202+
! Get the fieldIndex-th Field from a FieldBundle. The order of the Fields in FieldBundle
2203+
! is not guranteed. If this call is used iteratively, then any Add, Replace, or Remove
2204+
! call on the FieldBundle can change the order and/or number of Fields in that FieldBundle.
22052205
!
22062206
! \begin{description}
22072207
! \item [fieldbundle]
22082208
! {\tt ESMF\_FieldBundle} to be queried.
22092209
! \item [fieldIndex]
2210-
! The fieldIndex-th Field to be returned.
2210+
! The index of the Field to be returned.
22112211
! \item [field]
22122212
! The fieldIndex-th Field to be returned.
22132213
! \item [{[rc]}]

0 commit comments

Comments
 (0)