Skip to content

Clean up pod in the lib directory #1264

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

Merged
merged 1 commit into from
Jul 11, 2025

Conversation

pstaabp
Copy link
Member

@pstaabp pstaabp commented Jul 7, 2025

This cleans up some of the POD in the lib/ directory. This will be part of #1244 with only the perl modules.

This started with a fix of the spelling error for SYNOPSIS throughout the POD. Some of the modules got a little more love to further document, but there is much more to do (not in this PR).

Also fixes spelling of SYNOPSIS
@pstaabp pstaabp changed the base branch from main to PG-2.20 July 7, 2025 18:37
Copy link
Member

@drgrice1 drgrice1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good. This is much easier to review with only the lib changes most of which are rather minor.


returns an object of type AnswerHash.
$rh_anshash = new AnswerHash;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please change this to

Suggested change
$rh_anshash = new AnswerHash;
$rh_anshash = AnswerHash->new;

so that the indirect syntax is not encouraged.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I merged before I saw this last comment. I'll open a PR now that has this.

@Alex-Jordan Alex-Jordan merged commit 0d01f87 into openwebwork:PG-2.20 Jul 11, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants