capitalize functions + some doc changes

Author: wassup05

doc/specs/stdlib_system.md

@@ -418,7 +418,7 @@ Returns one of the `integer` `OS_*` parameters representing the OS type, from th
 
 ---
 
-## `fs_error` - Helper function for error handling
+## `FS_ERROR` - Helper function for error handling
 
 ### Status
 
@@ -430,15 +430,15 @@ A helper function for returning the `type(state_type)` with the flag `STDLIB_FS_
 
 ### Syntax
 
-`err = fs_error([a1,a2,a3,a4...... a20])`
+`err = FS_ERROR([a1,a2,a3,a4...... a20])`
 
 ### Class
 Pure Function
 
 ### Arguments
 
-`a1,a2,a3.....a20`(optional) : They are of type `class(*), dimension(..), optional, intent(in)`. 
-An arbitrary list of `integer`, `real`, `complex`, or `character` variables. Numeric variables may be provided as either scalars or rank-1 (array) inputs.
+`a1,a2,a3.....a20`(optional): They are of type `class(*), dimension(..), optional, intent(in)`. 
+An arbitrary list of `integer`, `real`, `complex`, `character` or `string_type` variables. Numeric variables may be provided as either scalars or rank-1 (array) inputs.
 
 ### Behavior
 
@@ -456,7 +456,7 @@ Formats all the arguments into a nice error message, utilizing the constructor o
 
 ---
 
-## `fs_error_code` - Helper function for error handling (with error code)
+## `FS_ERROR_CODE` - Helper function for error handling (with error code)
 
 ### Status
 
@@ -469,15 +469,17 @@ It also formats and prefixes the `code` passed to it as the first argument.
 
 ### Syntax
 
-`err = fs_error(code [, a1,a2,a3,a4...... a19])`
+`err = FS_ERROR_CODE(code [, a1,a2,a3,a4...... a19])`
 
 ### Class
 Pure Function
 
 ### Arguments
 
-`a1,a2,a3.....a19`: They are of type `class(*), dimension(..), optional, intent(in)`.
-An arbitrary list of `integer`, `real`, `complex`, or `character` variables. Numeric variables may be provided as either scalars or rank-1 (array) inputs.
+`code`: An `integer` code.
+
+`a1,a2,a3.....a19`(optional): They are of type `class(*), dimension(..), optional, intent(in)`.
+An arbitrary list of `integer`, `real`, `complex`, `character` or `string_type` variables. Numeric variables may be provided as either scalars or rank-1 (array) inputs.
 
 ### Behavior
 

example/system/example_fs_error.f90

@@ -1,19 +1,19 @@
-! Demonstrate usage of `fs_error`, `fs_error_code`
+! Demonstrate usage of `FS_ERROR`, `FS_ERROR_CODE`
 program example_fs_error
-    use stdlib_system, only: fs_error, fs_error_code
+    use stdlib_system, only: FS_ERROR, FS_ERROR_CODE
     use stdlib_error, only: state_type, STDLIB_FS_ERROR
     implicit none
 
     type(state_type) :: err0, err1
 
-    err0 = fs_error("Could not create directory", "`temp.dir`", "- Already exists")
+    err0 = FS_ERROR("Could not create directory", "`temp.dir`", "- Already exists")
 
     if (err0%state == STDLIB_FS_ERROR) then
         ! Error encountered: Filesystem Error: Could not create directory `temp.dir` - Already exists
         print *, err0%print() 
     end if
 
-    err1 = fs_error_code(1, "Could not create directory", "`temp.dir`", "- Already exists")
+    err1 = FS_ERROR_CODE(1, "Could not create directory", "`temp.dir`", "- Already exists")
 
     if (err1%state == STDLIB_FS_ERROR) then
         ! Error encountered: Filesystem Error: code - 1, Could not create directory `temp.dir` - Already exists

src/stdlib_system.F90

@@ -137,17 +137,17 @@ module stdlib_system
 !! version: experimental
 !!
 !! A helper function for returning the `type(state_type)` with the flag `STDLIB_FS_ERROR` set.
-!! ([Specification](../page/specs/stdlib_system.html#fs_error))
+!! ([Specification](../page/specs/stdlib_system.html#FS_ERROR))
 !!
-public :: fs_error
+public :: FS_ERROR
 
 !! version: experimental
 !!
 !! A helper function for returning the `type(state_type)` with the flag `STDLIB_FS_ERROR` set.
 !! It also formats and prefixes the `code` passed to it as the first argument
-!! ([Specification](../page/specs/stdlib_system.html#fs_error_code))
+!! ([Specification](../page/specs/stdlib_system.html#FS_ERROR_CODE))
 !!
-public :: fs_error_code
+public :: FS_ERROR_CODE
 
 ! CPU clock ticks storage
 integer, parameter, private :: TICKS = int64
@@ -785,34 +785,34 @@ subroutine delete_file(path, err)
     end if
 end subroutine delete_file
 
-pure function fs_error_code(code,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10, & 
-        a11,a12,a13,a14,a15,a16,a17,a18, a19) result(state)
+pure function FS_ERROR_CODE(code,a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,& 
+        a11,a12,a13,a14,a15,a16,a17,a18,a19) result(state)
 
     type(state_type) :: state
     !> Platform specific error code
     integer, intent(in) :: code
     !> Optional rank-agnostic arguments
-    class(*), intent(in), optional, dimension(..) :: a1,a2,a3,a4,a5,a6,a7,a8,a9,a10, &
-        a11,a12,a13,a14,a15,a16,a17,a18, a19
+    class(*), intent(in), optional, dimension(..) :: a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,&
+        a11,a12,a13,a14,a15,a16,a17,a18,a19
 
     character(32) :: code_msg
 
     write(code_msg, "('code - ', i0, ',')") code
 
-    state = state_type(STDLIB_FS_ERROR, code_msg,a1,a2,a3,a4,a5,a6,a7,a8, &
-        a9,a10,a11,a12,a13,a14,a15,a16,a17,a18, a19)
-end function fs_error_code
+    state = state_type(STDLIB_FS_ERROR, code_msg,a1,a2,a3,a4,a5,a6,a7,a8,&
+        a9,a10,a11,a12,a13,a14,a15,a16,a17,a18,a19)
+end function FS_ERROR_CODE
 
-pure function fs_error(a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11, &
+pure function FS_ERROR(a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,&
         a12,a13,a14,a15,a16,a17,a18,a19,a20) result(state)
 
     type(state_type) :: state
     !> Optional rank-agnostic arguments
-    class(*), intent(in), optional, dimension(..) :: a1,a2,a3,a4,a5,a6,a7,a8,a9,a10, &
+    class(*), intent(in), optional, dimension(..) :: a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,&
         a11,a12,a13,a14,a15,a16,a17,a18,a19,a20
 
-    state = state_type(STDLIB_FS_ERROR, a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12, &
+    state = state_type(STDLIB_FS_ERROR, a1,a2,a3,a4,a5,a6,a7,a8,a9,a10,a11,a12,&
         a13,a14,a15,a16,a17,a18,a19,a20)
-end function fs_error
+end function FS_ERROR
 
 end module stdlib_system

test/system/test_filesystem.f90

@@ -1,6 +1,6 @@
 module test_filesystem
     use testdrive, only : new_unittest, unittest_type, error_type, check, skip_test
-    use stdlib_system, only: is_directory, delete_file, fs_error, fs_error_code
+    use stdlib_system, only: is_directory, delete_file, FS_ERROR, FS_ERROR_CODE
     use stdlib_error, only: state_type, STDLIB_FS_ERROR
 
     implicit none
@@ -13,7 +13,7 @@ subroutine collect_suite(testsuite)
         type(unittest_type), allocatable, intent(out) :: testsuite(:)
 
         testsuite = [ &
-            new_unittest("fs_error", test_FS_ERROR), &
+            new_unittest("fs_error", test_fs_error), &
             new_unittest("fs_is_directory_dir", test_is_directory_dir), &
             new_unittest("fs_is_directory_file", test_is_directory_file), &
             new_unittest("fs_delete_non_existent", test_delete_file_non_existent), &
@@ -28,17 +28,17 @@ subroutine test_fs_error(error)
         character(:), allocatable :: msg
 
         msg = "code - 10, Cannot create File temp.txt - File already exists"
-        s1 = fs_error_code(10, "Cannot create File temp.txt -", "File already exists")
+        s1 = FS_ERROR_CODE(10, "Cannot create File temp.txt -", "File already exists")
 
         call check(error, s1%state == STDLIB_FS_ERROR .and. s1%message == msg, &
-            "fs_error_code: Could not construct the state with code correctly")
+            "FS_ERROR_CODE: Could not construct the state with code correctly")
         if (allocated(error)) return
 
         msg = "Cannot create File temp.txt - File already exists"
-        s2 = fs_error("Cannot create File temp.txt -", "File already exists")
+        s2 = FS_ERROR("Cannot create File temp.txt -", "File already exists")
 
         call check(error, s2%state == STDLIB_FS_ERROR .and. s2%message == msg, &
-            "fs_error: Could not construct state without code correctly")
+            "FS_ERROR: Could not construct state without code correctly")
         if (allocated(error)) return
     end subroutine test_fs_error