Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for NUOPC_CompAttributeIngest using freeformat with lists #333

Closed
danrosen25 opened this issue Dec 11, 2024 · 5 comments · Fixed by #339
Closed

Update documentation for NUOPC_CompAttributeIngest using freeformat with lists #333

danrosen25 opened this issue Dec 11, 2024 · 5 comments · Fixed by #339
Assignees

Comments

@danrosen25
Copy link
Member

Update documentation for NUOPC_CompAttributeIngest to acknowledge that whitespace delimited lists do not work.
Lists will fail (quietly) if line has spaces.

see issue #293

@danrosen25 danrosen25 self-assigned this Dec 11, 2024
@danrosen25
Copy link
Member Author

danrosen25 commented Dec 19, 2024

@theurich @anntsay

Does this change read okay?
Current documentation 3.6.15 NUOPC_CompAttributeIngest - Ingest free format NUOPC GridComp Attributes

Replacing

-!   Important: Attributes ingested by this method are stored as type character
-!   strings, and must be accessed accordingly. Conversion from string into a
-!   different data type, e.g. {\tt integer} or {\tt real}, is the user's
-!   responsibility.

with

+!   Important: Attributes ingested by this method are stored as type character
+!   strings, and must be accessed accordingly. Conversion from string into a
+!   different data type, e.g. {\tt integer} or {\tt real}, is the user's
+!   responsibility. This method does not support value lists. Attribute values
+!   ingested by this method must not contain whitespace within the value. If
+!   whitespace is found within the value the attribute will not be added to
+!   the comp.
+!
+!   The following entry will be ignored
+!   \begin{verbatim}
+!     attributeName = attributeValue1 attributeValue2 attributedValue3
+!   \end{verbatim}
+!   The following entry is acceptable
+!   \begin{verbatim}
+!     attributeName = attributeValue1,attributeValue2,attributedValue3
+!   \end{verbatim}

@theurich
Copy link
Member

Dan, I think that could do. I was hoping though that we could use the opportunity to more clearly lay out the formatting rules in general with respect to white spaces. I know that will require a lot more additions to explain it.

@theurich
Copy link
Member

@danrosen25 do you think you will want to push something in today still?

@danrosen25
Copy link
Member Author

@danrosen25 do you think you will want to push something in today still?

Sorry, I lost track with the ESMF performance test. I have a PR open now. I think it's good to go but I wasn't sure what you want for 'more clarity' but I tried in the PR.

@theurich
Copy link
Member

I just merged PR #339 into release/8.8.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants