You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 PR is actually very AI-heavy. I used ChatGPT to tidy up the existing docstrings and create ones where they were missing. I validated them afterwards and I found no problems. Despite this, I put a disclaimer on the API docs page because I believe that AI-generated contributions and content should always be disclosed.
The reason will be displayed to describe this comment to others. Learn more.
Hi @iboates, Thanks for this PR. Overall it looks good. I suggest to somehow include the notes part in the code. If the note section is raising some issue, I suggest to move it up, in the starting section of the docstring.
Hi @iboates, Thanks for this PR. Overall it looks good. I suggest to somehow include the notes part in the code. If the note section is raising some issue, I suggest to move it up, in the starting section of the docstring.
Apart from that, it looks good to me.
Sure, I also noticed that some of the nice organizational headers were removed by the almighty wise and all-knowing AI, I will put them back as well
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.
Closes #46
This PR is actually very AI-heavy. I used ChatGPT to tidy up the existing docstrings and create ones where they were missing. I validated them afterwards and I found no problems. Despite this, I put a disclaimer on the API docs page because I believe that AI-generated contributions and content should always be disclosed.
Incidentally, the api docs page is currently broken. I built the docs locally and they seem to work now: