tests: amend docstrings

* Amend false docstrings.
* Rename a couple of modules.

cylc/rose/platform_utils.py

@@ -15,8 +15,9 @@
 # You should have received a copy of the GNU General Public License
 # along with Rose. If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------
-"""Interfaces for Cylc Platforms for use by rose apps.
-"""
+
+"""Interfaces for Cylc Platforms for use by rose apps."""
+
 from optparse import Values
 import sqlite3
 import subprocess

cylc/rose/utilities.py

@@ -14,9 +14,7 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Cylc support for reading and interpreting ``rose-suite.conf`` workflow
-configuration files.
-"""
+"""Cylc support for reading and interpreting ``rose-suite.conf`` files."""
 
 import itertools
 import os

tests/conftest.py

@@ -13,8 +13,6 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""Functional tests for top-level function record_cylc_install_options and
-"""
 
 from types import SimpleNamespace
 

tests/functional/test_ROSE_ORIG_HOST.py

@@ -15,6 +15,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Rose. If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------
+
 """
 Tests for cylc.rose.stem
 ========================

tests/functional/test_pre_configure.py

@@ -13,8 +13,8 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""Functional tests for top-level function record_cylc_install_options and
-"""
+
+"""Test pre_configure entry point."""
 
 from itertools import product
 import os

tests/functional/test_reinstall.py

@@ -13,6 +13,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 """Functional tests for reinstalling of config files.
 This test does the following:
 

tests/functional/test_reinstall_clean.py

@@ -13,6 +13,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 """Functional tests for reinstalling of config files.
 This test does the following:
 

tests/functional/test_reinstall_fileinstall.py

@@ -13,7 +13,9 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""Cylc reinstall is able to use the async fileinstall from rose without
+
+"""
+Ensure Cylc reinstall is able to use the async fileinstall from rose without
 trouble.
 """
 

tests/functional/test_rose_fileinstall.py

@@ -13,8 +13,8 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""Functional tests for top-level function record_cylc_install_options and
-"""
+
+"""Functional tests for Rose file installation."""
 
 from pathlib import Path
 import shutil

tests/functional/test_rose_stem.py

@@ -17,6 +17,7 @@
 # You should have received a copy of the GNU General Public License
 # along with Rose. If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------
+
 """
 Tests for cylc.rose.stem
 ========================

tests/functional/test_copy_config_file.py → tests/functional/test_utils.py

@@ -13,9 +13,8 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""Functional tests for top-level function cylc.rose.entry points
-copy_config_file.
-"""
+
+"""Unit tests for utilities."""
 
 from pathlib import Path
 

tests/functional/test_validate_no_rose_ignore_items.py

@@ -13,6 +13,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 """Functional Test: It ignores commented items in rose-suite.conf
 
 See https://github.com/cylc/cylc-rose/pull/171

tests/unit/test_config_node.py

@@ -13,6 +13,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 """Tests the plugin with Rose suite configurations via the Python API."""
 
 from types import SimpleNamespace

tests/unit/test_config_tree.py

@@ -13,6 +13,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 """Tests the plugin with Rose suite configurations on the filesystem."""
 
 from io import StringIO

tests/unit/test_rose_opts.py → tests/unit/test_fileinstall.py

@@ -13,8 +13,8 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""Functional tests for top-level function record_cylc_install_options and
-"""
+
+"""Unit tests for Rose file installation."""
 
 from pathlib import Path
 import shutil

tests/unit/test_functional_post_install.py

@@ -13,6 +13,7 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 """Functional tests for top-level function record_cylc_install_options and
 rose_fileinstall
 

tests/unit/test_platform_utils.py

@@ -15,8 +15,8 @@
 # You should have received a copy of the GNU General Public License
 # along with Rose. If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------
-"""Tests for platform utils module:
-"""
+
+"""Tests for platform utils module."""
 
 import os
 from pathlib import Path

tests/unit/test_rose_stem_units.py

@@ -13,8 +13,8 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
-"""Functional tests for top-level function record_cylc_install_options and
-"""
+
+"""Unit tests for Rose Stem."""
 
 from types import SimpleNamespace
 from typing import Any, Tuple