Clean up pod in the lib directory#1264
Merged
Alex-Jordan merged 1 commit intoopenwebwork:PG-2.20from Jul 11, 2025
Merged
Conversation
Also fixes spelling of SYNOPSIS
drgrice1
approved these changes
Jul 8, 2025
Member
drgrice1
left a comment
drgrice1
left a comment
There was a problem hiding this comment.
This looks good. This is much easier to review with only the lib changes most of which are rather minor.
| Usage | ||
|
|
||
| returns an object of type AnswerHash. | ||
| $rh_anshash = new AnswerHash; |
Member
There was a problem hiding this comment.
Please change this to
Suggested change
| $rh_anshash = new AnswerHash; | |
| $rh_anshash = AnswerHash->new; |
so that the indirect syntax is not encouraged.
Contributor
There was a problem hiding this comment.
I merged before I saw this last comment. I'll open a PR now that has this.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
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).