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

adding initial docs for structure as transform #1172

Merged
merged 5 commits into from
Sep 17, 2024

Conversation

emjay07
Copy link
Contributor

@emjay07 emjay07 commented Sep 13, 2024

Describe your changes

Adding docs for Structure as Transform

Issue ticket number and link

N/A


📚 Documentation preview 📚: https://griptape--1172.org.readthedocs.build//1172/

@emjay07 emjay07 requested a review from a team September 13, 2024 00:13
Copy link

codecov bot commented Sep 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

Copy link
Member

@collindutter collindutter left a comment

Choose a reason for hiding this comment

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

Can we provide any sort of example of a payload here? Or link to a sample structure?

@emjay07
Copy link
Contributor Author

emjay07 commented Sep 16, 2024

I can move my Sample structure to the public repo and link that. When you say example Payload, do you mean to create a DC with a Transform?

@collindutter
Copy link
Member

I just mean including some sort of snippet that explains what this:

Ensure the Structure you select to run as a Transform is configured to take in a ListArtifact as its first positional argument and returns either a TextArtifact or ListArtifact.

looks like in practice.

@emjay07
Copy link
Contributor Author

emjay07 commented Sep 16, 2024

Will do -- the Sample will cover that.

@collindutter collindutter merged commit 04057a1 into dev Sep 17, 2024
15 checks passed
@collindutter collindutter deleted the docs/gtc-structure-as-transform branch September 17, 2024 18:26
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