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

More advanced type checking and documentation #1323

Merged
merged 10 commits into from
Dec 15, 2020

Conversation

revans2
Copy link
Collaborator

@revans2 revans2 commented Dec 8, 2020

I know this is a huge change, and I am happy to put in some comments in the code if needed. Please take a look.

Signed-off-by: Robert (Bobby) Evans <bobby@apache.org>
@revans2
Copy link
Collaborator Author

revans2 commented Dec 8, 2020

build

@revans2
Copy link
Collaborator Author

revans2 commented Dec 9, 2020

build

@sameerz sameerz added the documentation Improvements or additions to documentation label Dec 10, 2020
@jlowe
Copy link
Member

jlowe commented Dec 11, 2020

This looks OK to me. Would like to see a bit more documentation for the TypeChecks functions, but that's minor.

@revans2
Copy link
Collaborator Author

revans2 commented Dec 14, 2020

@jlowe I upmerged and updated the scaladocs for the new type checking.

@revans2
Copy link
Collaborator Author

revans2 commented Dec 14, 2020

build

@revans2
Copy link
Collaborator Author

revans2 commented Dec 14, 2020

build

jlowe
jlowe previously approved these changes Dec 14, 2020
@revans2
Copy link
Collaborator Author

revans2 commented Dec 14, 2020

build

@tgravescs
Copy link
Collaborator

could you add a high level overview of how this is supposed to work in description.

}

/**
* N/A neither spark not the plugin supports this.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit - s/not/nor/

* Both Spark and the plugin support this.
* @param asterisks true if we need to include an asterisks because it is not really 100% supported.
*/
class Supported(val asterisks: Boolean = false) extends SupportLevel {
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we need note here for asterisks or do you end up seeing that elsewhere?

* A signature for types that are generally supported by the plugin. Please make sure to check
* what Spark actually supports instead of blindly using this in a signature.
*/
val legacySupportedTypes: TypeSig = BOOLEAN + BYTE + SHORT + INT + LONG + FLOAT + DOUBLE + DATE +
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

legacy makes me think this is old deprecated types (it might just be me though), would it be better to say something like basic types or commonSupportedTypes. Not a big deal though as I can't think of anything great either.

@revans2
Copy link
Collaborator Author

revans2 commented Dec 15, 2020

build

@revans2
Copy link
Collaborator Author

revans2 commented Dec 15, 2020

@tgravescs and @jlowe could you take another look?

@revans2 revans2 merged commit 0d3cd53 into NVIDIA:branch-0.4 Dec 15, 2020
@revans2 revans2 deleted the type_doc_check_support branch December 15, 2020 20:15
nartal1 pushed a commit to nartal1/spark-rapids that referenced this pull request Jun 9, 2021
Signed-off-by: Robert (Bobby) Evans <bobby@apache.org>
nartal1 pushed a commit to nartal1/spark-rapids that referenced this pull request Jun 9, 2021
Signed-off-by: Robert (Bobby) Evans <bobby@apache.org>
tgravescs pushed a commit to tgravescs/spark-rapids that referenced this pull request Nov 30, 2023
…IDIA#1323)

Signed-off-by: spark-rapids automation <70000568+nvauto@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants