Skip to content

[MINOR] Update javadoc for RexChecker with Litmus argument#3536

Merged
mihaibudiu merged 1 commit intoapache:mainfrom
yeahthisisrob:doc-updates
Dec 27, 2023
Merged

[MINOR] Update javadoc for RexChecker with Litmus argument#3536
mihaibudiu merged 1 commit intoapache:mainfrom
yeahthisisrob:doc-updates

Conversation

@yeahthisisrob
Copy link
Contributor

Update the javadoc for RexChecker to reflect changes from https://issues.apache.org/jira/browse/CALCITE-955

@yeahthisisrob yeahthisisrob changed the title update javadoc for RexChecker Litmus argument Fix: Update javadoc for RexChecker with Litmus argument Nov 19, 2023
* RelDataType rowType;
* RexChecker checker = new RexChecker(rowType, Litmus.IGNORE);
* node.accept(checker);
* if (!checker.isValid()) {
Copy link
Contributor

Choose a reason for hiding this comment

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

The original javadoc had two examples, whereas here there is only one.
I do find that the assert-based example is useful.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, I completely missed the first example. I recently used IGNORE and was focused there. Updated!

@julianhyde
Copy link
Contributor

Remove 'Fix:' from the commit message. That's not a prefix we use in this project.

@yeahthisisrob yeahthisisrob changed the title Fix: Update javadoc for RexChecker with Litmus argument Update javadoc for RexChecker with Litmus argument Nov 21, 2023
@JiajunBernoulli
Copy link
Contributor

@yeahthisisrob , Would you please add [MINOR] to commit message?

@yeahthisisrob yeahthisisrob changed the title Update javadoc for RexChecker with Litmus argument [MINOR] Update javadoc for RexChecker with Litmus argument Nov 24, 2023
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@mihaibudiu mihaibudiu merged commit a7cc2bb into apache:main Dec 27, 2023
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.

4 participants