Skip to content

Add module docstrings to scripts #787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

willingc
Copy link
Contributor

@willingc willingc commented Jul 18, 2025

References and relevant issues

Partially addresses #785

Description

I'm not sure how I feel about this PR since AI was used. The module docstrings were generated by Claude Code, which I have been testing for another project. I'm opening the PR since it may help @ian-coccimiglio and others understand our scripts which generate the events page and other auto-generated content.

I'm fine if we wish to close this and never merge into the codebase. In the short-term, I do think it gives useful information.

I have added an attribution statement to each docstring as well.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jul 18, 2025
@willingc willingc changed the title Add modulte docstrings to scripts Add module docstrings to scripts Jul 18, 2025
@TimMonko
Copy link
Contributor

To me, this is a prime use case of AI for code maintenance, and is generally how I use it myself (figuring out what's going on in a file without having to parse the code). So, the only reason I would not have to support this is that sometimes module docstrings go out of date and we don't uupdate them well enough. I'm in favor of how you've done this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants