🔧 Remove hidden field from extra_options (#1124)

This field is never used, and is likely unintentional duplicate of `hide` (denoting a need that is hidden in the rendered documentation)
useblocks · Feb 22, 2024 · 98777ea · 98777ea
1 parent e142d24
commit 98777ea
Show file tree

Hide file tree

Showing 24 changed files with 5 additions and 172 deletions.
diff --git a/docs/configuration.rst b/docs/configuration.rst
@@ -155,17 +155,6 @@ And use it like:
       :tags: important;complex;
       :impacts: really everything
 
-Default value:
-
-.. code-block:: python
-
-   {'hidden': directives.unchanged}
-
-The ``hidden`` option is a globally available option always hidden and used to easily execute :ref:`dynamic_functions`.
-
-Extra options automatically appear in needs, if a value is set.
-By using :ref:`needs_hide_options` the output of such options can be hidden.
-
 .. note:: To filter on these options in `needlist`, `needtable`, etc. you
           must use the :ref:`filter` option.
 

diff --git a/docs/examples/needs.json b/docs/examples/needs.json
@@ -33,7 +33,6 @@
                     "github": "",
                     "has_dead_links": "",
                     "has_forbidden_dead_links": "",
-                    "hidden": "",
                     "hours": "",
                     "id": "test_req",
                     "id_complete": "test_req",
@@ -113,7 +112,6 @@
                     "github": "",
                     "has_dead_links": "",
                     "has_forbidden_dead_links": "",
-                    "hidden": "",
                     "hours": "",
                     "id": "xyz_123",
                     "id_complete": "xyz_123",

diff --git a/sphinx_needs/data.py b/sphinx_needs/data.py
@@ -177,7 +177,6 @@ class NeedsInfoType(TypedDict):
 
     # default extra options
     # TODO these all default to "" which I don't think is good
-    hidden: str
     duration: str
     completion: str
     # constraints: str  # this is already set in create_need

diff --git a/sphinx_needs/needs.py b/sphinx_needs/needs.py
@@ -514,7 +514,6 @@ def prepare_env(app: Sphinx, env: BuildEnvironment, _docname: str) -> None:
 
     # Own extra options
     for option in [
-        "hidden",
         "duration",
         "completion",
         "constraints",

diff --git a/tests/__snapshots__/test_basic_doc.ambr b/tests/__snapshots__/test_basic_doc.ambr
@@ -31,7 +31,6 @@
             'full_title': 'Test story',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'ST_001',
             'id_prefix': '',
             'is_external': False,
@@ -99,7 +98,6 @@
             'full_title': 'No ID',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'US_38823',
             'id_prefix': '',
             'is_external': False,

diff --git a/tests/__snapshots__/test_export_id.ambr b/tests/__snapshots__/test_export_id.ambr
@@ -137,7 +137,6 @@
             'full_title': 'My requirement',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'REQ_001',
             'id_prefix': '',
             'is_external': False,
@@ -213,7 +212,6 @@
             'full_title': 'My requirement 2',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'REQ_002',
             'id_prefix': '',
             'is_external': False,
@@ -286,7 +284,6 @@
             'full_title': 'My requirement 3',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'REQ_003',
             'id_prefix': '',
             'is_external': False,
@@ -359,7 +356,6 @@
             'full_title': 'My requirement 4',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'REQ_004',
             'id_prefix': '',
             'is_external': False,
@@ -437,7 +433,6 @@
             'full_title': 'Req 5',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'REQ_005',
             'id_prefix': '',
             'is_external': False,
@@ -541,7 +536,6 @@
             'full_title': 'Test of requirements',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'TEST_001',
             'id_prefix': '',
             'is_external': False,
@@ -616,7 +610,6 @@
             'full_title': 'Test of requirements2',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'TEST_002',
             'id_prefix': '',
             'is_external': False,
@@ -691,7 +684,6 @@
             'full_title': 'Test of requirements 5',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'TEST_003',
             'id_prefix': '',
             'is_external': False,

diff --git a/tests/__snapshots__/test_external.ambr b/tests/__snapshots__/test_external.ambr
@@ -31,7 +31,6 @@
             'full_title': 'TEST_01 DESCRIPTION',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'EXT_TEST_01',
             'id_prefix': '',
             'is_external': True,
@@ -99,7 +98,6 @@
             'full_title': 'TEST_02 DESCRIPTION',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'EXT_TEST_02',
             'id_prefix': '',
             'is_external': True,
@@ -170,7 +168,6 @@
             'full_title': 'Test requirement 1',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'REQ_1',
             'id_prefix': '',
             'is_external': False,
@@ -238,7 +235,6 @@
             'full_title': 'Test specification 1',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'SPEC_1',
             'id_prefix': '',
             'is_external': False,
@@ -308,7 +304,6 @@
             'full_title': 'Sub-Req',
             'has_dead_links': False,
             'has_forbidden_dead_links': False,
-            'hidden': '',
             'id': 'SUB_002',
             'id_prefix': '',
             'is_external': False,