Update / generate the docstrings #994
Conversation
kristiankyvik
force-pushed
the
generate-docstrings
branch
from
ffc37d7
to
e4f9f54
Compare
| @@ -221,10 +316,22 @@ def get_files_from_toml(self, input_path, toml_file): | |||
| return selected_files | |||
|
|
|||
| def merge_file_lists( | |||
| self, existing_files: list[str], new_files: list[str] | |||
There was a problem hiding this comment.
Out of curiosity, did you do this @kristiankyvik , or was this an automatic type correction?
There was a problem hiding this comment.
This was GPT-engineer. Despite me explicitly requesting it to limit itself to adding/editing docstrings, in some cases, it took the liberty of also correcting the parameter types. I figured I would also keep these suggestions in the PR after manually reviewing them.
|
Wow, massive PR! Great work. Its so comprehensive I didn't read it all. Is there any reason why we should not merge it @kristiankyvik , if not, I'll click the button :) |
|
I see no reason for us not to merge this other than us perhaps merging this PR first as this should fix the docs build. I already made some changes to the PR based on your feedback from yesterday. |
kristiankyvik
force-pushed
the
generate-docstrings
branch
from
bd02a09
to
2671cbb
Compare
|
I think this can be merged now, @ATheorell since #999 has been merged. We are now down to only 18 errors, all related to static files that will be addresses in the last PR of this series, #996. |
This PR generated the docstrings in the NumPy style for all the code. In some cases it also updates outdated docstrings.
As suggested by @ATheorell, I used gpt-engineer CLI to generate all of docstrings.
This will properly populate the API reference section of the
gpte-engineerdocs (see image below):I think we should try to merge this PR before, that fixes the documentation build before merging this one as described in the original issue.