Apply suggestions from code review

Co-authored-by: Eirini Koutsaniti <[email protected]>

docs/howto.rst

@@ -52,7 +52,7 @@ In this case we set the CFLAGS and also pass Makefile target to the Make build s
             build_system.flags = ['-O3']
 
 
-Based on the selected build system, ReFrame will generate the analogous build script.
+Based on the selected build system, ReFrame will generate the appropriate build script.
 
 .. code-block:: bash
 
@@ -222,7 +222,7 @@ To run this test, use the same container as with EasyBuild:
 
    docker run -h myhost --mount type=bind,source=$(pwd)/examples/,target=/home/user/reframe-examples -it <IMAGE>  /bin/bash -l
 
-Conversely to EasyBuild, Spack does not require a modules systems to be configured, so you could simply run the test with the ReFrame's builtin configuration:
+Conversely to EasyBuild, Spack does not require a modules systems to be configured, so you could simply run the test with ReFrame's builtin configuration:
 
 .. code-block:: bash
 
@@ -312,7 +312,7 @@ Working with environment modules
 ================================
 
 A common practice in HPC environments is to provide the software stack through `environment modules <https://modules.readthedocs.io/>`__.
-An environment module is essentially a set of environment variables that are sourced in the user's current shell for making available the requested software stack components.
+An environment module is essentially a set of environment variables that are sourced in the user's current shell in order to make available the requested software stack components.
 
 ReFrame allows users to associate an environment modules system to a system in the configuration file.
 Tests may then specify the environment modules needed for them to run.
@@ -556,7 +556,7 @@ ReFrame will process them as usual, but instead of running the selected tests, i
 The generated ReFrame command that will run each individual test reuses the :option:`-C`, :option:`-R`, :option:`-v` and :option:`--mode` options passed to the initial invocation of ReFrame that was used to generate the pipeline.
 Users can define CI-specific execution modes in their configuration in order to pass arbitrary options to the ReFrame invocation in the child pipeline.
 
-Finally, we pass the generated CI pipeline file to second phase as an artifact and we are done!
+Finally, we pass the generated CI pipeline file to the second phase as an artifact and we are done!
 If ``image`` keyword is defined in ``.gitlab-ci.yml``, the emitted pipeline will use the same image as the one defined in the parent pipeline.
 Besides, each job in the generated pipeline will output a separate junit report which can be used to create GitLab badges.
 
@@ -725,7 +725,7 @@ In total, we expect six :class:`stream_test` versions to be generated by this co
 The process for generating the actual tests from this spec file comprises three steps and everything happens in a somewhat unconventional, though valid, ReFrame test file:
 
 1. We load the test configuration from a spec file that is passed through the ``STREAM_SPEC_FILE`` environment variable.
-2. Based on the loaded test specs we generate the actual tests using the :func:`~reframe.core.meta.make_test` function.
+2. Based on the loaded test specs, we generate the actual tests using the :func:`~reframe.core.meta.make_test` function.
 3. We register the generated tests with the framework by applying manually the :func:`@simple_test <reframe.core.decorators.simple_test>` decorator.
 
 The whole code for generating the tests is the following and is only a few lines.

docs/tutorial.rst

@@ -166,7 +166,7 @@ This can be suppressed by increasing the level at which this information is logg
 Run reports and performance logging
 -----------------------------------
 
-Once a test session finishes, ReFrame a generates a detailed JSON report under ``$HOME/.reframe/reports``.
+Once a test session finishes, ReFrame generates a detailed JSON report under ``$HOME/.reframe/reports``.
 Every time ReFrame is run a new report will be generated automatically.
 The latest one is always symlinked by the ``latest.json`` name, unless the :option:`--report-file` option is given.
 
@@ -211,7 +211,7 @@ The ``rfm_job.sh`` is the actual test script that was generated and executed and
    #!/bin/bash
    stream.x
 
-Inspecting  test failures
+Inspecting test failures
 -------------------------
 
 When a test fails, ReFrame will not move its artifacts to the output directory and will keep everything inside the stage directory.
@@ -1202,7 +1202,7 @@ Accessing CPU topology information
 .. versionadded:: 3.7
 
 Sometimes a test may need to access processor topology information for the partition it runs so as to better set up the run.
-Of course, you could hard code the information in the test, but wouldn't be so portable.
+Of course, you could hard code the information in the test, but it wouldn't be so portable.
 ReFrame auto-detects the local host topology and it can also auto-detect the topology of remote hosts.
 It makes available this information to the test through the :attr:`current_partition`'s :attr:`~reframe.core.systems.SystemPartition.processor` attribute.
 
@@ -1390,7 +1390,7 @@ You can instruct the :option:`-l` to list the actual (concretized) test cases th
     - stream_build_test /6c084d40 @pseudo-cluster:compute+clang
     Concretized 4 test case(s)
 
-Notice the ``@pseudo-cluster:login+gnu`` notation that is append to each test case:
+Notice the ``@pseudo-cluster:login+gnu`` notation that is appended to each test case:
 this is the exact combination of partition and environment that the test will run for.
 
 You can also opt for a detailed listing with the :option:`-L` option, which also accepts the ``C`` argument for producing the concretized test cases.
@@ -1755,7 +1755,7 @@ By default, ReFrame generates a debug log file in the system's temporary directo
 This is quite a detailed log.
 Logging can be configured in the :attr:`~config.logging` section of the configuration file.
 Multiple logging handlers can be registered that will log messages to different sinks at different levels.
-Let's see an example on how to setup  ReFrame to save its output in a ``reframe_<timestamp>.out` and a detailed debug output in ``reframe_<timestamp>.log``:
+Let's see an example on how to setup ReFrame to save its output in a ``reframe_<timestamp>.out` and a detailed debug output in ``reframe_<timestamp>.log``:
 
 .. literalinclude:: ../examples/tutorial/config/cluster_logging.py
    :caption:
@@ -1822,7 +1822,7 @@ The ``filelog`` handler manages the writing of performance data to files per tes
 Let's walk briefly through the most important parts of its configuration:
 
 - The :attr:`~config.logging.handlers_perflog..filelog..prefix` is an additional directory prefix under the global prefix (see :option:`--prefix` option) where the perflogs will be saved.
-  The formatting placeholders are described below
+  The formatting placeholders are described below.
 - The :attr:`~config.logging.handlers_perflog.format` specifies how the log record will be formatted.
   Each placeholder of the form ``%(placeholder)s`` is replaced by the actual value during runtime.
   All placeholders starting with ``check_`` refer to test attributes.

examples/tutorial/config/baseline.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2024 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause

examples/tutorial/config/baseline_contplatf.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2024 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause

examples/tutorial/config/baseline_environs.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2024 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause

examples/tutorial/config/baseline_modules.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2024 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause

examples/tutorial/stream/stream_runonly.py

@@ -1,4 +1,4 @@
-# Copyright 2016-2023 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
+# Copyright 2016-2024 Swiss National Supercomputing Centre (CSCS/ETH Zurich)
 # ReFrame Project Developers. See the top-level LICENSE file for details.
 #
 # SPDX-License-Identifier: BSD-3-Clause