minor comments + doc changes

Author: wassup05

doc/specs/stdlib_system.md

@@ -558,11 +558,11 @@ Subroutine
 
 `path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
 
-`err`(optional): Shall be of type `state_type`, for error handling. It is an `optional, intent(out)` argument.
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `optional, intent(out)` argument.
 
 ### Return values
 
-`err` is an optional state return flag. On error if not requested, a `FS_ERROR` will trigger an error stop.
+`err` is an optional state return flag. If not requested and an error occurs, a `FS_ERROR` will trigger an error stop.
 
 ### Example
 
@@ -581,7 +581,7 @@ Experimental
 ### Description
 
 It creates an empty directory with default permissions.
-It also creates all the parent directories required in doing so.
+It also creates all the necessary parent directories in the path if they do not exist already.
 
 ### Syntax
 
@@ -595,11 +595,11 @@ Subroutine
 
 `path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
 
-`err`(optional): Shall be of type `state_type`, for error handling. It is an `optional, intent(out)` argument.
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `optional, intent(out)` argument.
 
 ### Return values
 
-`err` is an optional state return flag. On error if not requested, a `FS_ERROR` will trigger an error stop.
+`err` is an optional state return flag. If not requested and an error occurs, a `FS_ERROR` will trigger an error stop.
 
 ### Example
 
@@ -632,7 +632,7 @@ Subroutine
 
 `path`: Shall be a character string containing the path of the directory to create. It is an `intent(in)` argument.
 
-`err`(optional): Shall be of type `state_type`, for error handling. It is an `intent(out)` argument.
+`err`(optional): Shall be of type `state_type`, and is used for error handling. It is an `optional, intent(out)` argument.
 
 ### Return values
 

src/stdlib_system.F90

@@ -120,8 +120,8 @@ module stdlib_system
 !!
 !! ### Description
 !! This function makes an empty directory according to the path provided.
-!! Relative paths as well as on Windows, paths involving either `/` or `\` are accepted.
-!! Appropriate error message is returned whenever any error occurs.
+!! Relative paths are supported. On Windows, paths involving either `/` or `\` are accepted.
+!! An appropriate error message is returned whenever any error occurs.
 !!
 public :: make_directory
 
@@ -135,9 +135,9 @@ module stdlib_system
 !!
 !! ### Description
 !! This function makes an empty directory according to the path provided.
-!! It also creates all the parent directories required in doing so.
-!! Relative paths as well as on Windows, paths involving either `/` or `\` are accepted.
-!! Appropriate error message is returned whenever any error occurs.
+!! It also creates all the necessary parent directories in the path if they do not exist already.
+!! Relative paths are supported.
+!! An appropriate error message is returned whenever any error occurs.
 !!
 public :: make_directory_all
 
@@ -151,8 +151,8 @@ module stdlib_system
 !!
 !! ### Description
 !! This function Removes an empty directory according to the path provided.
-!! Relative paths as well as on Windows paths involving either `/` or `\` are accepted.
-!! Appropriate error message is returned whenever any error occurs.
+!! Relative paths are supported. On Windows paths involving either `/` or `\` are accepted.
+!! An appropriate error message is returned whenever any error occurs.
 !!
 public :: remove_directory
 
@@ -1000,7 +1000,7 @@ subroutine make_directory_all(path, err)
     end do
 end subroutine make_directory_all
 
-!! Removes an empty directory
+!! removes an empty directory
 subroutine remove_directory(path, err)
     character(len=*), intent(in) :: path
     type(state_type), optional, intent(out) :: err

test/system/test_filesystem.f90

@@ -187,7 +187,7 @@ subroutine test_make_directory(error)
         call check(error, err%ok(), 'Could not make directory: '//err%print())
         if (allocated(error)) return
 
-        ! Clean up: remove the empty directory
+        ! clean up: remove the empty directory
         call execute_command_line('rmdir ' // dir_name, exitstat=ios, cmdstat=iocmd, cmdmsg=msg)
         call check(error, ios==0 .and. iocmd==0, 'Cannot cleanup make_directory test: '//trim(msg))
     end subroutine test_make_directory
@@ -208,7 +208,7 @@ subroutine test_make_directory_existing(error)
         call make_directory(dir_name, err=err)
         call check(error, err%error(), 'Made an already existing directory somehow')
 
-        ! Clean up: remove the empty directory
+        ! clean up: remove the empty directory
         call execute_command_line('rmdir ' // dir_name, exitstat=ios, cmdstat=iocmd, cmdmsg=msg)
 
         if (allocated(error)) then
@@ -237,7 +237,7 @@ subroutine test_make_directory_all(error)
         call check(error, err%ok(), 'Could not make all directories: '//err%print())
         if (allocated(error)) return
 
-        ! Clean up: remove the empty directory
+        ! clean up: remove the empty directory
         if (is_windows()) then
             call execute_command_line('rmdir /s /q ' // dir_name, exitstat=ios, cmdstat=iocmd, cmdmsg=msg)
         else
@@ -264,7 +264,7 @@ subroutine test_remove_directory(error)
         call check(error, err%ok(), 'Could not remove directory: '//err%print())
 
         if (allocated(error)) then 
-            ! Clean up: remove the empty directory
+            ! clean up: remove the empty directory
             call execute_command_line('rmdir ' // dir_name, exitstat=ios, cmdstat=iocmd, cmdmsg=msg)
             call check(error, ios==0 .and. iocmd==0, error%message // ' and cannot cleanup make_directory test: '//trim(msg))
         end if