Re: [PR] Fix: CSV/Excel upload form change column dates description [superset]

Sat, 05 Apr 2025 11:43:17 -0700 


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


##########
superset/databases/schemas.py:
##########
@@ -1169,8 +1169,8 @@ class UploadPostSchema(BaseUploadFilePostSchemaMixin):
     column_dates = DelimitedListField(
         fields.String(),
         metadata={
-            "description": "[CSV and Excel only] A list of column names that 
should be "
-            "parsed as dates. Example: date,timestamp"
+            "description": "[CSV and Excel only] Select column names from a 
dropdown list that should be "
+            "parsed as dates."
         },
     )

Review Comment:
   ### Remove UI implementation detail from API description <sub>![category 
Documentation](https://img.shields.io/badge/Documentation-7c3aed)</sub>
   
   <details>
     <summary>Tell me more</summary>
   
   ###### What is the issue?
   The documentation implies a UI implementation detail (dropdown list) which 
may become outdated or inaccurate. Documentation should focus on the 
functionality rather than UI specifics.
   
   ###### Why this matters
   UI implementation details in API documentation can become misleading when 
the UI changes, causing confusion for API consumers.
   
   ###### Suggested change ∙ *Feature Preview*
       column_dates = DelimitedListField(
           fields.String(),
           metadata={
               "description": "[CSV and Excel only] A list of column names that 
should be "
               "parsed as dates."
           },
       )
   
   
   ###### 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/ae18cfef-238e-4b69-aa6a-608aaced1163/upvote)
 
[![Incorrect](https://img.shields.io/badge/👎%20Incorrect-white)](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/ae18cfef-238e-4b69-aa6a-608aaced1163?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/ae18cfef-238e-4b69-aa6a-608aaced1163?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/ae18cfef-238e-4b69-aa6a-608aaced1163?what_not_in_standard=true)
 
[![Other](https://img.shields.io/badge/👎%20Other-white)](https://app.korbit.ai/feedback/aa91ff46-6083-4491-9416-b83dd1994b51/ae18cfef-238e-4b69-aa6a-608aaced1163)
   </details>
   
   <sub>
   
   💬 Looking for more details? Reply to this comment to chat with Korbit.
   </sub>
   
   <!--- korbi internal id:4095ab1a-4c1b-4a8d-8482-a3920e0e7d4c -->
   
   [](4095ab1a-4c1b-4a8d-8482-a3920e0e7d4c)



-- 
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: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to