Skip to content

[SPARK-39677][SQL][DOCS][3.2] Fix args formatting of the regexp and like functions#37093

Closed
MaxGekk wants to merge 1 commit intoapache:branch-3.2from
MaxGekk:fix-regexp-docs-3.2
Closed

[SPARK-39677][SQL][DOCS][3.2] Fix args formatting of the regexp and like functions#37093
MaxGekk wants to merge 1 commit intoapache:branch-3.2from
MaxGekk:fix-regexp-docs-3.2

Conversation

@MaxGekk
Copy link
Member

@MaxGekk MaxGekk commented Jul 5, 2022

What changes were proposed in this pull request?

In the PR, I propose to fix args formatting of some regexp functions by adding explicit new lines. That fixes the following items in arg lists.

Before:

Screenshot 2022-07-05 at 09 48 28

After:

Screenshot 2022-07-05 at 11 06 13

Why are the changes needed?

To improve readability of Spark SQL docs.

Does this PR introduce any user-facing change?

No.

How was this patch tested?

By building docs and checking manually:

$ SKIP_SCALADOC=1 SKIP_PYTHONDOC=1 SKIP_RDOC=1 bundle exec jekyll build

Authored-by: Max Gekk max.gekk@gmail.com
Signed-off-by: Max Gekk max.gekk@gmail.com
(cherry picked from commit 4e42f8b)
Signed-off-by: Max Gekk max.gekk@gmail.com

…unctions

In the PR, I propose to fix args formatting of some regexp functions by adding explicit new lines. That fixes the following items in arg lists.

Before:

<img width="745" alt="Screenshot 2022-07-05 at 09 48 28" src="https://user-images.githubusercontent.com/1580697/177274234-04209d43-a542-4c71-b5ca-6f3239208015.png">

After:

<img width="704" alt="Screenshot 2022-07-05 at 11 06 13" src="https://user-images.githubusercontent.com/1580697/177280718-cb05184c-8559-4461-b94d-dfaaafda7dd2.png">

To improve readability of Spark SQL docs.

No.

By building docs and checking manually:
```
$ SKIP_SCALADOC=1 SKIP_PYTHONDOC=1 SKIP_RDOC=1 bundle exec jekyll build
```

Closes apache#37082 from MaxGekk/fix-regexp-docs.

Authored-by: Max Gekk <max.gekk@gmail.com>
Signed-off-by: Max Gekk <max.gekk@gmail.com>
(cherry picked from commit 4e42f8b)
Signed-off-by: Max Gekk <max.gekk@gmail.com>
@MaxGekk
Copy link
Member Author

MaxGekk commented Jul 5, 2022

Merging to 3.2 since all tests passed, and the fixes have been merged to master already.
Screenshot 2022-07-05 at 18 27 01

MaxGekk added a commit that referenced this pull request Jul 5, 2022
…ike functions

### What changes were proposed in this pull request?
In the PR, I propose to fix args formatting of some regexp functions by adding explicit new lines. That fixes the following items in arg lists.

Before:

<img width="745" alt="Screenshot 2022-07-05 at 09 48 28" src="https://user-images.githubusercontent.com/1580697/177274234-04209d43-a542-4c71-b5ca-6f3239208015.png">

After:

<img width="704" alt="Screenshot 2022-07-05 at 11 06 13" src="https://user-images.githubusercontent.com/1580697/177280718-cb05184c-8559-4461-b94d-dfaaafda7dd2.png">

### Why are the changes needed?
To improve readability of Spark SQL docs.

### Does this PR introduce _any_ user-facing change?
No.

### How was this patch tested?
By building docs and checking manually:
```
$ SKIP_SCALADOC=1 SKIP_PYTHONDOC=1 SKIP_RDOC=1 bundle exec jekyll build
```

Authored-by: Max Gekk <max.gekkgmail.com>
Signed-off-by: Max Gekk <max.gekkgmail.com>
(cherry picked from commit 4e42f8b)
Signed-off-by: Max Gekk <max.gekkgmail.com>

Closes #37093 from MaxGekk/fix-regexp-docs-3.2.

Authored-by: Max Gekk <max.gekk@gmail.com>
Signed-off-by: Max Gekk <max.gekk@gmail.com>
@MaxGekk MaxGekk closed this Jul 5, 2022
sunchao pushed a commit to sunchao/spark that referenced this pull request Jun 2, 2023
…ike functions

### What changes were proposed in this pull request?
In the PR, I propose to fix args formatting of some regexp functions by adding explicit new lines. That fixes the following items in arg lists.

Before:

<img width="745" alt="Screenshot 2022-07-05 at 09 48 28" src="https://user-images.githubusercontent.com/1580697/177274234-04209d43-a542-4c71-b5ca-6f3239208015.png">

After:

<img width="704" alt="Screenshot 2022-07-05 at 11 06 13" src="https://user-images.githubusercontent.com/1580697/177280718-cb05184c-8559-4461-b94d-dfaaafda7dd2.png">

### Why are the changes needed?
To improve readability of Spark SQL docs.

### Does this PR introduce _any_ user-facing change?
No.

### How was this patch tested?
By building docs and checking manually:
```
$ SKIP_SCALADOC=1 SKIP_PYTHONDOC=1 SKIP_RDOC=1 bundle exec jekyll build
```

Authored-by: Max Gekk <max.gekkgmail.com>
Signed-off-by: Max Gekk <max.gekkgmail.com>
(cherry picked from commit 4e42f8b)
Signed-off-by: Max Gekk <max.gekkgmail.com>

Closes apache#37093 from MaxGekk/fix-regexp-docs-3.2.

Authored-by: Max Gekk <max.gekk@gmail.com>
Signed-off-by: Max Gekk <max.gekk@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant