Skip to content

Commit

Permalink
Merge pull request #218 from briandobbins/esmfinfo-doc-fix-dobbins
Browse files Browse the repository at this point in the history
Minor documentation tweak for ESMF_Info section (Infrastructure/Base)
  • Loading branch information
theurich authored Oct 16, 2024
2 parents c0ea79a + f2fd88e commit 3ed6fcf
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions src/Infrastructure/Base/doc/Info_desc.tex
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,6 @@ \subsection{Key Format Overview}
\label{info_key_format}
A key in the \texttt{ESMF\_Info} interface provides the location of a value to retrieve from the key-value storage. Keys in the \texttt{ESMF\_Info} class use the JSON Pointer syntax \cite{json_for_modern_cpp_json_pointer}. A forward slash is prepended to string keys if it does not exist. Hence, \texttt{"aKey"} and \texttt{"/aKey"} are equivalent. Note the indexing aspect of the JSON Pointer syntax is not supported.

Every "key" argument in the \texttt{ESMF\_Info} class uses pathing following the JSON Pointer syntax [6]. A forward slash is prepended to string keys if it does not exist. Hence, "aKey" and "/aKey" are equivalent. Note the indexing aspect of the JSON Pointer syntax is not supported (i.e. "/my\_list~1").

Some examples for valid "key" arguments:
\begin{itemize}
\item \texttt{altitude} :: A simple key argument with no nesting.
Expand Down

0 comments on commit 3ed6fcf

Please sign in to comment.