Repository: deepchecks/deepchecks

Issue:
Suite output text - fix first part
1. Add explanation for the “!” (warning) 2. add link to docs where written (or remove wording), where it says:"Suites, checks and conditions can all be modified (see tutorial [link])."


Discussion:
@noamzbr 

**point 1**
sorry I did not get you, where exactly do we need to add an explanation?

**point 2**
we do not have an example that shows how to modify existing suites or checks. Maybe it would be better to replace it with

```
If needed you can add your own check to the suite (link to the `add_a_custom_check` example) or replace an existing one
```

but, honestly, I think this sentence is redundant/ in my opinion, it will be weird for the user-defined suites to contain links to the deepchecks resources



Hi @yromanyshyn :)

about 1 -
it's
"Each check may contain conditions (which results in ✓ / ✖ / ! )"
so to write something like
"Each check may contain conditions (which will result in pass / fail / warning, represented by ✓ / ✖ / !)"

and about the tutorial link, it should be to here:
https://docs.deepchecks.com/en/stable/examples/guides/create_a_custom_suite.html
(yes the current link is broken cause it's under "latest" but soon will be in "stable" as well)

About the redundant part - I agree, I think it the future we'll want to drop the "suite" oral explanation completely, once we have a wide enough user base, but for initial adoption of "lazy users that never heard about us and want to make the minimal effort to understand what it's about" then it can be useful, and that's why this whole explanation exists in the first place.
But currently - there will be much more - first-time users, that use the "built-in suites", and see if they gain a quick understanding, that's why we're trying to optimize on that scenario.

Resolving patch:
diff --git a/deepchecks/base/display_suite.py b/deepchecks/base/display_suite.py
--- a/deepchecks/base/display_suite.py
+++ b/deepchecks/base/display_suite.py
@@ -109,14 +109,20 @@ def display_suite_result(suite_name: str, results: List[Union[CheckResult, Check
         else f"The suite is composed of the following checks: {', '.join(check_names)}."
     )
 
+    suite_creation_example_link = 'https://docs.deepchecks.com/en/stable/examples/guides/create_a_custom_suite.html'
+
     display_html(
         f"""
         <h1 id="summary_{unique_id}">{suite_name}</h1>
-        <p>{prologue}<br>
-        Each check may contain conditions (which results in {icons}),
-        as well as other outputs such as plots or tables.<br>
-        Suites, checks and conditions can all be modified (see tutorial [link]).</p>
-        {bold_hr}<h2>Conditions Summary</h2>
+        <p>
+            {prologue}<br>
+            Each check may contain conditions (which will result in pass / fail / warning, represented by {icons})
+            as well as other outputs such as plots or tables.<br>
+            Suites, checks and conditions can all be modified (see the
+            <a href={suite_creation_example_link}>Create a Custom Suite</a> tutorial).
+        </p>
+        {bold_hr}
+        <h2>Conditions Summary</h2>
         """,
         raw=True
     )


Test patch: