search

esmf-org / esmf

The Earth System Modeling Framework (ESMF) is a suite of software tools for developing high-performance, multi-component Earth science modeling applications.
https://earthsystemmodeling.org/
Other
156 stars 75 forks source link

Missing nogarbage argument in HConfigDestroy? #211

Closed tclune closed 8 months ago

tclune commented 8 months ago

Currently ESMF_HConfigDestroy does not have the nogarbage argument, but the procedure documentation says:

"By default a small remnant of the object is kept in memory in order to prevent problems with dangling aliases. The default garbage collection mechanism can be overridden with the noGarbage argument."

oehmke commented 8 months ago

Gerhard (@theurich), I assigned this to you, but if you don't think that you'll have time to do it, let me know and I'll take a look.

theurich commented 8 months ago

Bob (@oehmke ), I just assigned it to myself (but left you as well). I think this is just a simple doc fix. The ESMF_HConfig does not connect to ESMF_Base, and hence not integrated into ESMF garbage collection. Just a copy-n-paste issue about the sentence in the docs that should not be there. I will double check, and then correct the doc.

oehmke commented 8 months ago

Ah! that makes sense about ESMF_Base. Thanks!

On Jan 19, 2024, at 9:35 AM, Gerhard Theurich @.***> wrote:

Bob @.*** https://github.com/oehmke ), I just assigned it to myself (but left you as well). I think this is just a simple doc fix. The ESMF_HConfig does not connect to ESMF_Base, and hence not integrated into ESMF garbage collection. Just a copy-n-paste issue about the sentence in the docs that should not be there. I will double check, and then correct the doc.

— Reply to this email directly, view it on GitHub https://github.com/esmf-org/esmf/issues/211#issuecomment-1900733719, or unsubscribe https://github.com/notifications/unsubscribe-auth/AE6A7U3NYVJGUS7F3H4BS23YPKOFPAVCNFSM6AAAAABCA4F6NWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMBQG4ZTGNZRHE. You are receiving this because you were mentioned.

theurich commented 8 months ago

The doc fix is on develop and shows online at: https://earthsystemmodeling.org/docs/nightly/develop/ESMF_refdoc/node6.html#SECTION0601051900000000000000