Merge pull request #35 from kognitos/fix-all-linting-issues

fix: fixed all docstring issues

Author: matib-kognitos

tests/test_lint.py

@@ -1,43 +1,43 @@
-import os
-import subprocess
-
-import pytest
-from change_dir import change_dir
-from generate_project import generate_project
-from pylint.lint import Run
-from pylint.reporters import CollectingReporter
-
-PROJECT_SLUG = "test_project"
-PROJECT_NAME = "Test Project"
-
-
-def run_pylint(project_directory):
-    report = CollectingReporter()
-
-    src_directory = os.path.join(project_directory, "src", PROJECT_SLUG)
-
-    with change_dir(project_directory):
-        result = subprocess.run(["poetry", "install"], capture_output=True, text=True)
-
-        try:
-            pylint_output = Run([src_directory], reporter=report, exit=False)
-
-            pylint_score = pylint_output.linter.stats.global_note
-        except Exception as e:
-            pylint_score = None
-
-    return pylint_score, report.messages
-
-
-@pytest.mark.parametrize(
-    "generate_project",
-    [{"project_slug": PROJECT_SLUG, "project_name": PROJECT_NAME}],
-    indirect=True,
-)
-def test_pylint_passes(generate_project):
-    pylint_score, pylint_messages = run_pylint(generate_project)
-
-    # Check if pylint passed based on your criteria, for example, a score of 8.0+
-    assert (
-        pylint_score >= 8.0
-    ), f"Pylint failed with score {pylint_score}\n{pylint_messages}"
+import os
+import subprocess
+
+import pytest
+from change_dir import change_dir
+from generate_project import generate_project
+from pylint.lint import Run
+from pylint.reporters import CollectingReporter
+
+PROJECT_SLUG = "test_project"
+PROJECT_NAME = "Test Project"
+
+
+def run_pylint(project_directory):
+    report = CollectingReporter()
+
+    src_directory = os.path.join(project_directory, "src", PROJECT_SLUG)
+
+    with change_dir(project_directory):
+        result = subprocess.run(["poetry", "install"], capture_output=True, text=True)
+
+        try:
+            pylint_output = Run([src_directory], reporter=report, exit=False)
+
+            pylint_score = pylint_output.linter.stats.global_note
+        except Exception as e:
+            pylint_score = None
+
+    return pylint_score, report.messages
+
+
+@pytest.mark.parametrize(
+    "generate_project",
+    [{"project_slug": PROJECT_SLUG, "project_name": PROJECT_NAME}],
+    indirect=True,
+)
+def test_pylint_passes(generate_project):
+    pylint_score, pylint_messages = run_pylint(generate_project)
+
+    # Check if pylint passed
+    assert (
+        pylint_score == 10.0
+    ), f"Pylint failed with score {pylint_score}\n{pylint_messages}"

{{cookiecutter.project_folder_name}}/src/{{cookiecutter.project_slug}}/__init__.py

@@ -1,5 +1,3 @@
-"""
-Initialization file for {{ cookiecutter.__book_class_name }}
-"""
+"""Initialization file for {{ cookiecutter.__book_class_name }}"""
 
 from .book import {{ cookiecutter.__base_url_name }}, {{ cookiecutter.__book_class_name }}

{{cookiecutter.project_folder_name}}/src/{{cookiecutter.project_slug}}/book.py

@@ -1,6 +1,4 @@
-"""
-{{cookiecutter.project_description}}
-"""
+"""{{cookiecutter.project_description}}"""
 
 import logging
 from typing import Optional
@@ -21,16 +19,14 @@
 
 @book(icon="data/icon.svg", name="{{ cookiecutter.project_name }}", tags=["Example"])
 class {{ cookiecutter.__book_class_name }}:
-    """
-    A book for {{cookiecutter.project_description}}
+    """A book for {{cookiecutter.project_description}}
 
     Author:
       {{cookiecutter.author_name}}
     """
 
     def __init__(self):
-        """
-        Initializes an instance of the class.
+        """Initializes an instance of the class.
 
         :param self: The instance of the class.
         """
@@ -40,8 +36,7 @@ def __init__(self):
 
     @property
     def timeout(self) -> float:
-        """
-        Get the value of the timeout.
+        """Get the value of the timeout.
 
         Parameters:
             None
@@ -54,8 +49,7 @@ def timeout(self) -> float:
 
     @timeout.setter
     def timeout(self, timeout: float):
-        """
-        Sets the timeout value in milliseconds.
+        """Sets the timeout value in milliseconds.
 
         Args:
             timeout (int): The timeout value to set. Must be a positive integer.
@@ -70,8 +64,7 @@ def timeout(self, timeout: float):
 
     @connect(noun_phrase="api keys", name="Api Keys")
     def connect(self, api_key: str):
-        """
-        Connects to an API using the provided API key.
+        """Connects to an API using the provided API key.
 
         Arguments:
             api_key: The API key to be used for connecting
@@ -96,8 +89,7 @@ def connect(self, api_key: str):
     def current_temperature(
         self, city: NounPhrase, unit: Optional[NounPhrase] = NounPhrase("metric")
     ) -> float:
-        """
-        Fetch the current temperature for a specified city.
+        """Fetch the current temperature for a specified city.
 
         Input Concepts:
             the city: The name of the city. Please refer to ISO 3166 for the state codes or country codes.
@@ -142,8 +134,7 @@ def current_temperature(
 
     @procedure("to capitalize a (string)", connection_required=ConnectionRequired.NEVER)
     def capitalize_string(self, string: str) -> str:
-        """
-        Capitalizes the input string.
+        """Capitalizes the input string.
 
         Input Concepts:
             the string: The string value you want to capitalize.