DOCS: Improve docstring for "frappe.client.get_value" #29040
Conversation
This file contains 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
This commit improves the existing docstring for the frappe.client.get_value API. Specifically, it adds information about all of the available arguments and provides additional information about the return values and potential exceptions. Examples are also provided in the docstring now
github-actions
bot
added
the
add-test-cases
|
@ankush could you please help me here? i'm not sure if you're one of the code owners here but I'm not sure who else to ping (pinging you because you're the author of the most recent merged PR) A little bit of context - I intend to slowly improve docstrings across the entire framework. I plan to open one PR a day/few PRs a week because I'd prefer keeping the PRs small to make reviews quick and easy. Unless the maintainers don't prefer this approach. If necessary, i'd be happy to do one PR per week, updating docstrings in a few functions at a time, but I'm not comfortable with that approach. |
|
@rahulporuri the other approach of a larger PR covering more functions would be preferable. This does look good! |
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.
This commit improves the existing docstring for the
frappe.client.get_valueAPI. Specifically, it adds information about all of the available arguments and provides additional information about the return values and potential exceptions. Examples are also provided in the docstring now.The rendered docstring looks as follows