Skip to content

Commit

Permalink
add helper txt files (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam-Armstrong authored Nov 4, 2023
1 parent ee8feb5 commit a7465c9
Show file tree
Hide file tree
Showing 3 changed files with 711 additions and 0 deletions.
16 changes: 16 additions & 0 deletions resources/prompt.txt
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:
24 changes: 24 additions & 0 deletions resources/python_docstring_template.txt
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
"""
Loading

0 comments on commit a7465c9

Please sign in to comment.