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

[DocBash] adding chaining feature documentation #669

Merged
merged 9 commits into from
Feb 6, 2024

Conversation

pengyu-hou
Copy link
Collaborator

Summary

Add documentation for chaining features

Why / Goal

Doc Bash

Test Plan

  • Added Unit Tests
  • Covered by existing CI
  • Integration tested

Checklist

  • Documentation update

Reviewers

@airbnb/zipline-maintainers

If you have similar features which would require multiple joins or groupbys, chaining features might be a good fit for your use case.

## How do I use it?
We introduced a new source type **JoinSource**. You can now pass in a parent join as Source in GroupBys.
Copy link
Collaborator

Choose a reason for hiding this comment

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

we may want to re-wording a bit stating it as a fact and removing "new feature" emphasis.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Done

Copy link
Contributor

@ezvz ezvz left a comment

Choose a reason for hiding this comment

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

Thanks for the work, @better365 !

A few suggestions.

Also, you need to modify the website code to add a page for this new document. I'd suggest adding it after the join documentation.

docs/source/authoring_features/ChainingFeatures.md Outdated Show resolved Hide resolved
docs/source/authoring_features/ChainingFeatures.md Outdated Show resolved Hide resolved
docs/source/authoring_features/ChainingFeatures.md Outdated Show resolved Hide resolved
docs/source/authoring_features/ChainingFeatures.md Outdated Show resolved Hide resolved
docs/source/authoring_features/ChainingFeatures.md Outdated Show resolved Hide resolved
docs/source/authoring_features/ChainingFeatures.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ezvz ezvz left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks @better365

@pengyu-hou pengyu-hou merged commit 06ff92e into master Feb 6, 2024
7 checks passed
@pengyu-hou pengyu-hou deleted the pengyu--chaining-explanation branch February 6, 2024 21:37
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