adriangb commented on PR #25716: URL: https://github.com/apache/datafusion/pull/25716#issuecomment-5857835780
> Can you please update the description of this PR to be more readable Highly agree, this is hard to read. @mohitgurav20 a prompt I find very useful: ``` - Write the description focusing on the impact / experience for users (for example a SQL MRE), don't focus on implementation details. - The target reader is a maintainer of DataFusion that is familiar with the space in general but may not be aware of this particular area / piece of the codebase. - Define any terms you may be introducing or that would be unfamiliar to the reader above. - Write using Simplified Technical English. - Consider using tables, diagrams, example code snippets, lists or other forms of communication over prose where possible. ``` -- 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]
