docs(jira): Improve field description in get_issue function #394
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Updated the documentation for the 'fields' parameter in the get_issue function to clarify that it accepts a comma-separated list of fields, a single field as a string, or '*all' for all fields. Added a note about raising a ValueError if the Jira client is not configured or available.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Closes #390
Updates the description for the
fieldsparameter in thejira_get_issuetool to clarify that a single field name string is also a valid input. The previous description only mentioned a comma-separated list, which could cause confusion.Changes
fieldsparameter description in thejira_get_issuetool to explicitly mention that a single field string (e.g.,"duedate") is a valid input, in addition to comma-separated lists or*all.fieldsparameter to maintain consistency.Testing
jira_get_issuetool with:fields="duedate": Verified correct behavior.fields="summary,status": Verified correct behavior.fields="*all": Verified correct behavior.fields=None(default): Verified correct behavior.fieldsparameter to confirm the type error is resolved.Checklist