Skip to content

Commit baef6df

Browse files
committed
docstring update
1 parent 2938bea commit baef6df

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

src/json_file_module.F90

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -580,7 +580,12 @@ function initialize_json_file(p,&
580580
!! will be nullified.
581581
#include "json_initialize_arguments.inc"
582582
logical(LK),intent(in),optional :: nullify_pointer !! if True, then `p` will be nullified
583-
!! if present. (default is True)
583+
!! if present. (default is True). Normally,
584+
!! this should be done, because the [[json_file]] will destroy
585+
!! the pointer when the class goes out of scope (causing `p` to be
586+
!! a dangling pointer). However, if the intent is to use `p` in
587+
!! a [[json_file]] and then call [[json_file:nullify]] and continue
588+
!! to use `p`, then this should be set to False.
584589

585590
call file_object%initialize(&
586591
#include "json_initialize_dummy_arguments.inc"

0 commit comments

Comments
 (0)