Re: A documentation change is a user-facing change

2025-01-16 Thread Wenchen Fan
+1 to update the PR template. I think the intent is to ask PR authors to call out all the user-facing changes that need attention from the end users, such as new features and behavior changes, but doc change is clearly not one of them. On Fri, Jan 17, 2025 at 7:10 AM Gengliang Wang wrote: > Than

Re: A documentation change is a user-facing change

2025-01-16 Thread Gengliang Wang
Thanks for pointing it out! Based on the discussion, I’ve created a PR: https://github.com/apache/spark/pull/49534. Let me know what you think! On Thu, Jan 16, 2025 at 2:25 PM Xiao Li wrote: > Thank you for pointing it out! Let’s update the template to exclude > documentation changes from the b

Re: A documentation change is a user-facing change

2025-01-16 Thread Xiao Li
Thank you for pointing it out! Let’s update the template to exclude documentation changes from the behavior change question. At the same time, I strongly believe that all behavior changes should be clearly documented in the PR description. For instance, in the first example PR https://github.com/a

Re: A documentation change is a user-facing change

2025-01-16 Thread Reynold Xin
Seems like we should fix the template if that's not the intent On Thu, Jan 16, 2025 at 1:52 PM Nicholas Chammas wrote: > The template says "including all aspects such as the documentation fix >

Re: A documentation change is a user-facing change

2025-01-16 Thread Nicholas Chammas
The template says "including all aspects such as the documentation fix .” The original intent may well have been about behavior changes only, but that’s not reflected in the curre

Re: A documentation change is a user-facing change

2025-01-16 Thread Dongjoon Hyun
The original intent is a user-facing *behavior* change technically which is the same with Apache Spark migration guide. If so, does it make sense to you? Probably, since the template was short to be concise, it could be interpreted in more ways than we thought. Dongjoon. On Thu, Jan 16, 2025 at

Re: A documentation change is a user-facing change

2025-01-16 Thread Nicholas Chammas
I didn’t write the pull request template and I am not sure about the author’s original intent. However, the plain meaning of “any” — with the added emphasis as well — suggests t

Re: A documentation change is a user-facing change

2025-01-16 Thread Dongjoon Hyun
I understand your concern, Nicholas. However, isn't it too strict? For the above example, adding a new HTML page is a user-facing change. https://github.com/apache/spark/pull/48852 (This is a new doc) [SPARK-50309][DOCS] Document SQL Pipe Syntax https://github.com/apache/spark/pull/49098 (This i