Skip to content

Commit 400d00a

Browse files
committed
doc(assert_m): clarify public interface
This commit adds comments to the assert_m module to clarify the purpose of the fortran_stringify_integer function and refer users to Julienne for a more broadly useful stringification capability.
1 parent 7fb03e0 commit 400d00a

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

src/assert_m.f90

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,15 @@
11
module assert_m
2-
use intrinsic_array_m, only : intrinsic_array_t
2+
!! Public interface
3+
use intrinsic_array_m, only : intrinsic_array_t
34
use assert_subroutine_m, only : assert, assert_always
4-
use characterizable_m, only : characterizable_t
5+
use characterizable_m, only : characterizable_t
6+
7+
! The function below is public only to support automated
8+
! invocation via `assert_macros.h`. For a more broadly useful
9+
! function to convert numeric data to string format, please
10+
! consider using the functions that can be accessed via the
11+
! `string_t` generic interface in the Julienne framework at
12+
! https://go.lbl.gov/julienne.
513
use fortran_stringify_integer_m, only : fortran_stringify_integer
614
implicit none
715
end module

0 commit comments

Comments
 (0)