Skip to content

Commit

Permalink
Specify more precisely which ISO version (8601) the TimeInterval set …
Browse files Browse the repository at this point in the history 
…from string usees.
  • Loading branch information
@oehmke
oehmke committed Oct 2, 2024
1 parent 32de985 commit 955adb5
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions src/Infrastructure/TimeMgr/interface/ESMF_TimeInterval.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3135,7 +3135,7 @@ end subroutine ESMF_ParseDurString
#undef ESMF_METHOD
#define ESMF_METHOD "ESMF_TimeIntervalSetStr()"
!BOP
! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO format string
! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO 8601 format string
! \label{API:TimeIntervalSetStr}

! !INTERFACE:
Expand All @@ -3152,7 +3152,7 @@ subroutine ESMF_TimeIntervalSetStr(timeinterval, timeIntervalString, rc)
!
! !DESCRIPTION:
! Sets the value of the {\tt ESMF\_TimeInterval} using a user specified
! string in ISO duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for information about the format. In ESMF's implementation the time values can have the following types:
! string in ISO 8601 duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for information about the format. In ESMF's implementation the time values can have the following types:
! \begin{description}
! \item[y] - the number of years expressed in up to a 64-bit integer
! \item[mm] - the number of months expressed in up to a 64-bit integer
Expand All @@ -3170,7 +3170,7 @@ subroutine ESMF_TimeIntervalSetStr(timeinterval, timeIntervalString, rc)
! \item[timeinterval]
! The object instance to initialize.
! \item[timeIntervalString]
! ISO format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
! ISO 8601 format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
! \item[{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
Expand Down Expand Up @@ -3229,7 +3229,7 @@ end subroutine ESMF_TimeIntervalSetStr
#undef ESMF_METHOD
#define ESMF_METHOD "ESMF_TimeIntervalSetStrCal()"
!BOP
! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO format string and calendar
! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO 8601 format string and calendar

! !INTERFACE:
! Private name; call using ESMF_TimeIntervalSet()
Expand All @@ -3246,7 +3246,7 @@ subroutine ESMF_TimeIntervalSetStrCal(timeinterval, calendar, &
!
! !DESCRIPTION:
! Sets the value of the {\tt ESMF\_TimeInterval} using a user specified
! string in ISO duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
! string in ISO 8601 duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
! information about the format. Also, see the description for the method
! {\tt ESMF\_TimeIntervalSetStr()}~\ref{API:TimeIntervalSetStr}
! for the specific types supported by ESMF for the values in the duration string.
Expand All @@ -3265,7 +3265,7 @@ subroutine ESMF_TimeIntervalSetStrCal(timeinterval, calendar, &
! it contains a calendar. Alternate to, and mutually exclusive with,
! calkindflag below. Primarily for specifying a custom calendar kind.
! \item[timeIntervalString]
! ISO format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
! ISO 8601 format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
! \item[{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
Expand Down Expand Up @@ -3325,7 +3325,7 @@ end subroutine ESMF_TimeIntervalSetStrCal
#undef ESMF_METHOD
#define ESMF_METHOD "ESMF_TimeIntervalSetStrCalTyp()"
!BOP
! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO format string and calendar kind
! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO 8601 format string and calendar kind

! !INTERFACE:
! Private name; call using ESMF_TimeIntervalSet()
Expand All @@ -3342,7 +3342,7 @@ subroutine ESMF_TimeIntervalSetStrCalTyp(timeinterval, calkindflag, &
!
! !DESCRIPTION:
! Sets the value of the {\tt ESMF\_TimeInterval} using a user specified
! string in ISO duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
! string in ISO 8601 duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
! information about the format. Also, see the description for the method
! {\tt ESMF\_TimeIntervalSetStr()}~\ref{API:TimeIntervalSetStr}
! for the specific types supported by ESMF for the values in the duration string.
Expand All @@ -3356,7 +3356,7 @@ subroutine ESMF_TimeIntervalSetStrCalTyp(timeinterval, calkindflag, &
! calendar above. More convenient way of specifying a built-in
! calendar kind.
! \item[timeIntervalString]
! ISO format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
! ISO 8601 format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
! \item[{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
Expand Down Expand Up @@ -3414,7 +3414,7 @@ end subroutine ESMF_TimeIntervalSetStrCalTyp
#undef ESMF_METHOD
#define ESMF_METHOD "ESMF_TimeIntervalSetStrStart()"
!BOP
! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO format string and start time
! !IROUTINE: ESMF_TimeIntervalSet - Initialize or set a TimeInterval from an ISO 8601 format string and start time

! !INTERFACE:
! Private name; call using ESMF_TimeIntervalSet()
Expand All @@ -3431,7 +3431,7 @@ subroutine ESMF_TimeIntervalSetStrStart(timeinterval, startTime, &
!
! !DESCRIPTION:
! Sets the value of the {\tt ESMF\_TimeInterval} using a user specified
! string in ISO duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
! string in ISO 8601 duration format P[y]Y[mm]M[d]DT[h]H[m]M[s]S. See ~\cite{ISO} and ~\cite{ISOnotes} for
! information about the format. Also, see the description for the method
! {\tt ESMF\_TimeIntervalSetStr()}~\ref{API:TimeIntervalSetStr}
! for the specific types supported by ESMF for the values in the duration string.
Expand All @@ -3446,7 +3446,7 @@ subroutine ESMF_TimeIntervalSetStrStart(timeinterval, startTime, &
! in time. If not set, and calendar also not set, calendar interval
! "floats" across all calendars and times.
! \item[timeIntervalString]
! ISO format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
! ISO 8601 format duration string (e.g. P[y]Y[mm]M[d]DT[h]H[m]M[s]S).
! \item[{[rc]}]
! Return code; equals {\tt ESMF\_SUCCESS} if there are no errors.
! \end{description}
Expand Down

0 comments on commit 955adb5

Please sign in to comment.