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

Nullable properties #172

Merged

Conversation

illided
Copy link
Contributor

@illided illided commented Aug 3, 2021

Allow list properties of function info be nullable implementing following behavior, which can help astminer run smoothly and be more predictable.

Condition Consequence
Feature is not implemented Exception thrown
Feature parsed badly Null return (instead of immediate exception)
Feature parsed normally (without any exceptions) Feature return

Copy link
Contributor

@SpirinEgor SpirinEgor left a comment

Choose a reason for hiding this comment

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

LGTM!
But could you also create documentation for FunctionInfo? Simple markdown file in docs/function_info.md where you can describe this behavior and in general how to work with it.

@illided
Copy link
Contributor Author

illided commented Aug 4, 2021

LGTM!
But could you also create documentation for FunctionInfo? Simple markdown file in docs/function_info.md where you can describe this behavior and in general how to work with it.

I don't think that we need a whole markdown file just for this... Won't javadoc be enough?
I think it would be better to add some guide about how to add new language / parser in docs that could point in proper directions.

@SpirinEgor
Copy link
Contributor

Fare enough. Let's create a doc file for the entire process of adding and supporting parsers/languages.

@SpirinEgor SpirinEgor merged commit f23862a into JetBrains-Research:master-dev Aug 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants