Re: [PR] fix: make flask-cors a core dependency [superset]

[via GitHub]

korbit-ai[bot] commented on code in PR #34115:
URL: https://github.com/apache/superset/pull/34115#discussion_r2195852558


##########
docs/docs/configuration/networking-settings.mdx:
##########
@@ -8,11 +8,11 @@ version: 1
 
 ## CORS
 
-To configure CORS, or cross-origin resource sharing, the following dependency 
must be installed:
 
-```python
-pip install apache_superset[cors]
-```
+:::note
+In Superset versions prior to `5.x` you have to install to install `flask-cors 
with` with `pip install apache-superset[cors]` to enable CORS support.

Review Comment:
   ### Unclear CORS Installation Instructions <sub>![category 
Readability](https://img.shields.io/badge/Readability-0284c7)</sub>
   
   <details>
     <summary>Tell me more</summary>
   
   ###### What is the issue?
   There is a duplicated word 'to install' in the text, and incorrect 
formatting of 'flask-cors with' which makes the instruction unclear and 
potentially confusing for users.
   
   
   ###### Why this matters
   Unclear installation instructions could lead to users making mistakes when 
trying to enable CORS support in older versions of Superset.
   
   ###### Suggested change ∙ *Feature Preview*
   Replace the text with clearer installation instructions:
   ```markdown
   In Superset versions prior to `5.x`, you have to install `flask-cors` with 
`pip install apache-superset[cors]` to enable CORS support.
   ```
   
   
   ###### Provide feedback to improve future suggestions
   [![Nice 
Catch](https://img.shields.io/badge/👍%20Nice%20Catch-71BC78)](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/3a867fa7-57c3-41a1-acdb-c5b67429d45d/upvote)
 
[![Incorrect](https://img.shields.io/badge/👎%20Incorrect-white)](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/3a867fa7-57c3-41a1-acdb-c5b67429d45d?what_not_true=true)
  [![Not in 
Scope](https://img.shields.io/badge/👎%20Out%20of%20PR%20scope-white)](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/3a867fa7-57c3-41a1-acdb-c5b67429d45d?what_out_of_scope=true)
 [![Not in coding 
standard](https://img.shields.io/badge/👎%20Not%20in%20our%20standards-white)](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/3a867fa7-57c3-41a1-acdb-c5b67429d45d?what_not_in_standard=true)
 
[![Other](https://img.shields.io/badge/👎%20Other-white)](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/3a867fa7-57c3-41a1-acdb-c5b67429d45d)
   </details>
   
   <sub>
   
   💬 Looking for more details? Reply to this comment to chat with Korbit.
   </sub>
   
   <!--- korbi internal id:9a56e185-1a87-467c-8545-940c81589489 -->
   
   
   [](9a56e185-1a87-467c-8545-940c81589489)



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org


---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscr...@superset.apache.org
For additional commands, e-mail: notifications-h...@superset.apache.org