Do not remove docs in settings and tests sections in GenerateDocument…

…ation (#634)
MarketSquare · Feb 3, 2024 · a6646c6 · a6646c6
1 parent 776b2ac
commit a6646c6
Show file tree

Hide file tree

Showing 7 changed files with 88 additions and 2 deletions.
diff --git a/docs/releasenotes/4.9.0.rst b/docs/releasenotes/4.9.0.rst
@@ -4,8 +4,8 @@
 Robotidy 4.9.0
 ==============
 
-Support skipping documentation in AlignSettingsSection with ``AlignSettingsSection:skip_documentation=True``
-or ``--skip-documentation`` skip options (#622).
+Allow to skip formatting documentation in ``AlignSettingsSection`` transformer and fix ``GenerateDocumentation``
+transformer removing documentation from settings and test cases sections.
 
 You can install the latest available version by running
 
@@ -22,3 +22,19 @@ or to install exactly this version
 .. contents::
    :depth: 2
    :local:
+
+Transformers changes
+====================
+
+Skip documentation option for AlignSettingsSection transformer (#622)
+---------------------------------------------------------------------
+Support skipping documentation in AlignSettingsSection with ``AlignSettingsSection:skip_documentation=True``
+or ``--skip-documentation`` skip options (#622).
+
+Fixes
+=====
+
+GenerateDocumentation overwriting documentation in Settings and Test Cases sections (#628)
+------------------------------------------------------------------------------------------
+
+``GenerateDocumentation`` transformer should now only overwrite documentation for the ``*** Keywords ***`` section.
diff --git a/robotidy/transformers/GenerateDocumentation.py b/robotidy/transformers/GenerateDocumentation.py
@@ -135,6 +135,11 @@ def __init__(self, overwrite: bool = False, doc_template: str = "google", templa
         self.args_returns_finder = ArgumentsAndReturnsVisitor()
         super().__init__()
 
+    def visit_TestCaseSection(self, node):  # noqa
+        return node
+
+    visit_SettingSection = visit_TestCaseSection
+
     def load_template(self, template: str, template_directory: Optional[str] = None) -> str:
         try:
             return Template(self.get_template(template, template_directory))

diff --git a/tests/atest/transformers/GenerateDocumentation/expected/overwrite.robot b/tests/atest/transformers/GenerateDocumentation/expected/overwrite.robot
@@ -1,3 +1,16 @@
+*** Settings ***
+Documentation    Suite documentation should not be changed.
+
+
+*** Test Cases ***
+Test without documentation
+    No Operation
+
+Test with documentation
+    [Documentation]    Should not be changed.
+    No Operation
+
+
 *** Keywords ***
 Single Argument
     [Documentation]    Short description.

diff --git a/tests/atest/transformers/GenerateDocumentation/expected/template_with_defaults.robot b/tests/atest/transformers/GenerateDocumentation/expected/template_with_defaults.robot
@@ -1,3 +1,16 @@
+*** Settings ***
+Documentation    Suite documentation should not be changed.
+
+
+*** Test Cases ***
+Test without documentation
+    No Operation
+
+Test with documentation
+    [Documentation]    Should not be changed.
+    No Operation
+
+
 *** Keywords ***
 Single Argument
     [Documentation]    Single Argument

diff --git a/tests/atest/transformers/GenerateDocumentation/expected/test.robot b/tests/atest/transformers/GenerateDocumentation/expected/test.robot
@@ -1,3 +1,16 @@
+*** Settings ***
+Documentation    Suite documentation should not be changed.
+
+
+*** Test Cases ***
+Test without documentation
+    No Operation
+
+Test with documentation
+    [Documentation]    Should not be changed.
+    No Operation
+
+
 *** Keywords ***
 Single Argument
     [Documentation]    Short description.

diff --git a/tests/atest/transformers/GenerateDocumentation/expected/test_rf4.robot b/tests/atest/transformers/GenerateDocumentation/expected/test_rf4.robot
@@ -1,3 +1,16 @@
+*** Settings ***
+Documentation    Suite documentation should not be changed.
+
+
+*** Test Cases ***
+Test without documentation
+    No Operation
+
+Test with documentation
+    [Documentation]    Should not be changed.
+    No Operation
+
+
 *** Keywords ***
 Single Argument
     [Documentation]    Short description.

diff --git a/tests/atest/transformers/GenerateDocumentation/source/test.robot b/tests/atest/transformers/GenerateDocumentation/source/test.robot
@@ -1,3 +1,16 @@
+*** Settings ***
+Documentation    Suite documentation should not be changed.
+
+
+*** Test Cases ***
+Test without documentation
+    No Operation
+
+Test with documentation
+    [Documentation]    Should not be changed.
+    No Operation
+
+
 *** Keywords ***
 Single Argument
     [Arguments]    ${var}