#448 Addressed documentation issues raised in review.

doc/source/examples.rst

@@ -55,7 +55,7 @@ out the re-created Fortran source code.
 
 create_dependencies.py
 ^^^^^^^^^^^^^^^^^^^^^^
-This file analysis the dependencies between a set of Fortran files, based on
+This file analyses the dependencies between a set of Fortran files, based on
 the ``Use`` statements in each file. It assumes that the module name in the
 ``use`` statement corresponds to the name of the file (adding one of
 .F90/.f90/.x90). Only files in the current directory will be tested, so
@@ -105,7 +105,7 @@ in a code section to a file. It also then creates a stand-alone driver program
 that will read this file, execute the kernel, and compare the results with
 the original results.
 
-Since PSyclone will follow call tree, the code must be able to read even
+Since PSyclone will follow the call tree, the code must be able to read even
 variables declared as ``private`` (to write them into the output file), and
 a driver program must be able to modify ``private`` and ``protected``
 variables in modules. If the driver creation is used, the 

example/Makefile

@@ -33,6 +33,9 @@
 # ------------------------------------------------------------------------------
 # Author: J. Henrichs, Bureau of Meteorology
 
+# A simple Makefile driver to test the various examples.
+
+
 .PHONY: test create_dependency fparser2_f2008 make_public split_file
 
 test:  create_dependencies fparser2_f2008 make_public split_file

example/make_public.py

@@ -3,7 +3,7 @@
 # -----------------------------------------------------------------------------
 # BSD 3-Clause License
 #
-# Copyright (c) 2020, Science and Technology Facilities Council.
+# Copyright (c) 2024, Science and Technology Facilities Council.
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -35,14 +35,13 @@
 # ------------------------------------------------------------------------------
 # Author: Joerg Henrichs, Bureau of Meteorology
 
-"""This file contains an fparser script that parses Fortran files
-and output the dependencies between these files suitable for a Makefile.
+"""This file contains a script that will remove any private or protected
+declaration in a Fortran file. This is used by PSyclone's kernel extraction
+and driver creation feature, see
+https://psyclone.readthedocs.io/en/latest/psyke.html.
+for details.
 
-It assumes that the module name in the use statement corresponds to the
-name of the file (adding one of .F90/.f90/.x90). Only files in the current
-directory will be tested, so external dependencies will not be listed.
-
-Usage:  create_dependencies.py  file1.f90 file2.F90 ...
+Usage:  make_public.py  file1.f90
 """
 
 import sys