-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ee8feb5
commit a7465c9
Showing
3 changed files
with
711 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
|
||
|
||
Human: | ||
<file> | ||
[file] | ||
</file> | ||
|
||
Hey Claude, can you create a docstring for the '[fn_name]' function defined in the file above? The doctoring should include a detailed description of the role the function plays and include a sentence describing each of the arguments in detail. The docstring should follow this format: | ||
|
||
<docstring_example> | ||
[docstring_example] | ||
</docstring_example> | ||
|
||
Only include ‘Raises’ if the function actively raises any exceptions, otherwise it can be ignored. It is critical that you only include the docstring itself, no preamble - your response needs to start with """. | ||
|
||
Assistant: |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
""" | ||
Description paragraph here. | ||
|
||
Parameters | ||
---------- | ||
first : array_like | ||
the 1st param description name `first` | ||
second : | ||
the 2nd param description | ||
third : {'value', 'other'}, optional description | ||
the 3rd param, by default 'value' | ||
|
||
Returns | ||
------- | ||
ret | ||
description of return | ||
|
||
Raises | ||
------ | ||
KeyError | ||
when a key error | ||
OtherError | ||
when an other error | ||
""" |
Oops, something went wrong.