Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.
Problem/Motivation
From #1315886: Clean up API docs for includes directory, files starting with A-C. archiver.inc
has the following minor code style issues:
- Double space after a period in constructor documentation.
- Missing period in the documentation for
ArchiverInterafce::extract()
. - Incorrect capitalization of type-hinting in
ArchiverInterafce::extract()
. (Array
should bearray
.)
Proposed resolution
Correct these style issues.
Remaining tasks
Postponed for #1315886: Clean up API docs for includes directory, files starting with A-C.
User interface changes
None.
API changes
None.
Comment | File | Size | Author |
---|---|---|---|
#7 | clean-up-minor-code-1326482-7.patch | 698 bytes | ryan.gibson |
Comments
Comment #1
xjmComment #2
xjmThis is probably unobtrusive enough to backport.
Comment #3
xjmComment #4
xjmComment #5
xjmActually, this would make a good novice issue.
Note that any patch for this issue will need to be rerolled once #1315886: Clean up API docs for includes directory, files starting with A-C is fixed, so probably best to wait until then.
Comment #6
ryan.gibson CreditAttribution: ryan.gibson commentedI can do this one :)
Comment #7
ryan.gibson CreditAttribution: ryan.gibson commentedOkay, this is my first time creating and uploading a patch - I couldn't see a double-space after a period in the constructor documentation. If I missed it, I can fix it. Wow, core office hours really are a great way to both help and learn. Now I can see a patch and understand it much better. I thought all of the patch info was typed manually. GIT really does the hard work.
Comment #8
tregeagle CreditAttribution: tregeagle commentedHey Ryan,
Nice one. The patch applies cleanly and it looks like all the typos are fixed.
Now I just need to find my first patch to roll...
Comment #9
webchickNot sure why the testbot didn't report back, but the tests passed.
Committed and pushed to 8.x and 7.x. Thanks! Congrats on your first core patch, Ryan! :D
Comment #10
jthorson CreditAttribution: jthorson commented#7: clean-up-minor-code-1326482-7.patch queued for re-testing.Sorry ... just troubleshooting testbots.
Comment #12
jthorson CreditAttribution: jthorson commentedComment #13.0
(not verified) CreditAttribution: commentedAdded clarification.