Re: [PR] chore: Update `spark_expressions_support.md` doc [datafusion-comet]

["andygrove (via GitHub)" <gi...@apache.org>]

andygrove commented on code in PR #4165:
URL: https://github.com/apache/datafusion-comet/pull/4165#discussion_r3170686422


##########
docs/source/contributor-guide/spark_expressions_support.md:
##########
@@ -19,6 +19,15 @@
 
 # Supported Spark Expressions
 
+## How to Read This Document
+
+- A function marked with `[x]` has a native implementation in Comet and does not fall back to Spark by default.
+- A function marked with `[ ]` has no native Comet implementation and falls back to Spark.
+- If a function has known incompatibilities with Spark, or conditions that cause it to fall back to Spark,
+  a sub-bullet labeled **Known issues** links to the relevant category page of the
+  [Compatibility Guide](../user-guide/latest/compatibility/expressions/index.md), where per-function
+  details are documented.

Review Comment:
   With this, we would now have to maintain this information manually and keep it in sync with the compatibility guide. For example, if we fix a compatibility issue we have to update this doc as well.
   
   Can we just make this more generic and say "all known compatibility issues are documented in the compatibility guide"?
   



-- 
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: github-unsubscribe@datafusion.apache.org

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


---------------------------------------------------------------------
To unsubscribe, e-mail: github-unsubscribe@datafusion.apache.org
For additional commands, e-mail: github-help@datafusion.apache.org