[SPARK-35582][PYTHON][DOCS] Remove # noqa in Python API documents. #32728
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
There is only one case remaining in the Please refer to: 3bda8db |
HyukjinKwon
approved these changes
Jun 1, 2021
|
Merged to master. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This PR aims to move
# noqain the Python docstring to the proper place so that hide them from the official documents.Why are the changes needed?
If we don't move
# noqato the proper place, it is exposed in the middle of the docstring, and it looks a bit wired as below:Does this PR introduce any user-facing change?
Yes, the
# noqais no more shown in the documents as below:How was this patch tested?
Manually build docs and check.