Skip to content

docs: update substrait builder javadoc and spelling#767

Merged
bestbeforetoday merged 3 commits intosubstrait-io:mainfrom
mbwhite:substrait-builder
Mar 24, 2026
Merged

docs: update substrait builder javadoc and spelling#767
bestbeforetoday merged 3 commits intosubstrait-io:mainfrom
mbwhite:substrait-builder

Conversation

@mbwhite
Copy link
Contributor

@mbwhite mbwhite commented Mar 18, 2026

Update to the JavaDoc for the Substrait Builder (and fix a spelling mistake)

This is ahead of some new functions coming in a follow on pr.

@mbwhite mbwhite force-pushed the substrait-builder branch from 0ff16d4 to c55a72d Compare March 18, 2026 14:06
Copy link
Member

@bestbeforetoday bestbeforetoday left a comment

Choose a reason for hiding this comment

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

Looks OK to me, apart from my complaints about misrepresenting this as a fluent builder API in the class doc. Probably just needs those words removed and the rest is fine.

Signed-off-by: MBWhite <whitemat@uk.ibm.com>
@mbwhite mbwhite force-pushed the substrait-builder branch from c55a72d to 5c8fb1c Compare March 20, 2026 09:12
@mbwhite
Copy link
Contributor Author

mbwhite commented Mar 20, 2026

thanks for spotting the incorrect phrasing @bestbeforetoday corrected.

I've got some additional methods for this class but wanted to 'tidy' up first.

@mbwhite mbwhite force-pushed the substrait-builder branch 2 times, most recently from 165517b to e81f09d Compare March 20, 2026 14:40
Signed-off-by: MBWhite <whitemat@uk.ibm.com>
@benbellick
Copy link
Member

Just sharing this here in case it was missed

In summary is it possible to:

  • use doc instead of fix in the commit?
  • have more descriptive titles that differentiate all of the partial isthmus if possible?

Thanks!!

@mbwhite mbwhite changed the title fix: update substrait builder javadoc and spelling docs: update substrait builder javadoc and spelling Mar 23, 2026
@mbwhite
Copy link
Contributor Author

mbwhite commented Mar 23, 2026

As soon as this has been merged I will bring #773 up for review

@bestbeforetoday bestbeforetoday merged commit 5451ad3 into substrait-io:main Mar 24, 2026
11 checks passed
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.

3 participants