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

expand transform-functions with examples #188

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

judell
Copy link
Contributor

@judell judell commented Apr 9, 2024

No description provided.

Copy link
Contributor

@johnsmyth johnsmyth left a comment

Choose a reason for hiding this comment

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

@judell It feels to me like this level of doc should be in the SDK instead of here. Maybe we should just include the table, but link to SDK docs instead of putting all the detail and examples here? I don't find that the examples for each add all that much, but they make the content much more dense.

@judell
Copy link
Contributor Author

judell commented Apr 16, 2024

@johnsmyth We could indeed link over to https://pkg.go.dev/github.com/turbot/steampipe-plugin-sdk/v5@v5.10.0/plugin/transform which has fragIDs for these things, like https://pkg.go.dev/github.com/turbot/steampipe-plugin-sdk/v5@v5.10.0/plugin/transform#hdr-FromField. And then slightly expand on each of the explanations there. In the case of FromJSONTag, for example, it's helpful to see the JSON tags in an SDK and compare with corresponding column definitions. For plugin developers who are new to Go (not uncommon) that kind of thing is useful context.

I'll ask for some additional feedback on this from a plugin developer.

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