added description to resolve_provider_doc_id tool#120
Conversation
kartheek-hc
left a comment
There was a problem hiding this comment.
Looks good, have a couple of questions and a suggestion
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the resolve_provider_doc_id tool by adding description snippets to the documentation output. It extracts brief summaries from Terraform provider documentation to help users better understand what each document contains before selecting it.
Key changes:
- Added description field to output format for both documentation handlers
- Implemented
getContentSnippetfunction to extract descriptions from provider documentation content - Updated output strings to include description information
Comments suppressed due to low confidence (1)
pkg/tools/resolve_provider_doc_id.go:242
- The variable name 'desc' is too abbreviated and unclear. Consider using a more descriptive name like 'description' or 'descriptionText'.
desc := ""
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
PCI review checklist
I have documented a clear reason for, and description of, the change I am making.
If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
If applicable, I've documented the impact of any changes to security controls.
Examples of changes to security controls include using new access control methods, adding or removing logging pipelines, etc.