Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove scaladoc on an internal method to avoid warning during build #2534

Merged

Conversation

razajafri
Copy link
Collaborator

Internal method to a private method doesn't need scaladocs. I have kept the comment as a multi-line comment.
I couldn't take this function up one level because we created the wrapper just so no one can misuse this function accidentally.

fixes #2495

Signed-off-by: Raza Jafri [email protected]

@razajafri razajafri changed the title Internal method doesn't need scaladocs Remove scaladoc on an internal method to avoid build-time distracting messages May 28, 2021
@razajafri
Copy link
Collaborator Author

build

@jlowe jlowe changed the title Remove scaladoc on an internal method to avoid build-time distracting messages Remove scaladoc on an internal method to avoid warning during build May 28, 2021
@jlowe jlowe added the build Related to CI / CD or cleanly building label May 28, 2021
Signed-off-by: Raza Jafri <[email protected]>
@razajafri razajafri requested a review from jlowe May 28, 2021 17:15
@jlowe
Copy link
Contributor

jlowe commented May 28, 2021

build

@razajafri razajafri merged commit bc2c839 into NVIDIA:branch-21.06 May 28, 2021
@razajafri razajafri deleted the remove-distracting-build-message branch May 28, 2021 20:01
nartal1 pushed a commit to nartal1/spark-rapids that referenced this pull request Jun 9, 2021
…VIDIA#2534)

* Internal method doesn't need scaladocs

Signed-off-by: Raza Jafri <[email protected]>

* added asterisk

Signed-off-by: Raza Jafri <[email protected]>

Co-authored-by: Raza Jafri <[email protected]>
nartal1 pushed a commit to nartal1/spark-rapids that referenced this pull request Jun 9, 2021
…VIDIA#2534)

* Internal method doesn't need scaladocs

Signed-off-by: Raza Jafri <[email protected]>

* added asterisk

Signed-off-by: Raza Jafri <[email protected]>

Co-authored-by: Raza Jafri <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Related to CI / CD or cleanly building
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] scaladoc warning GpuParquetScan.scala:727 "discarding unmoored doc comment"
2 participants