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 be array.)

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.

Files: 
CommentFileSizeAuthor
#7 clean-up-minor-code-1326482-7.patch698 bytesryanissamson
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch clean-up-minor-code-1326482-7.patch. This may be a -p0 (old style) patch, which is no longer supported by the testbots.
[ View ]

Comments

Status:Active» Postponed
Issue tags:-docs-cleanup-2011

Issue tags:+needs backport to D7

This is probably unobtrusive enough to backport.

Assigned:Unassigned» xjm

Priority:Normal» Minor

Assigned:xjm» Unassigned
Issue tags:+Novice

Actually, 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.

Assigned:Unassigned» ryanissamson

I can do this one :)

Status:Postponed» Needs review
StatusFileSize
new698 bytes
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch clean-up-minor-code-1326482-7.patch. This may be a -p0 (old style) patch, which is no longer supported by the testbots.
[ View ]

Okay, 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.

Status:Needs review» Reviewed & tested by the community

Hey 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...

Status:Reviewed & tested by the community» Fixed

Not 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

Status:Fixed» Needs review
Issue tags:-Novice, -needs backport to D7

#7: clean-up-minor-code-1326482-7.patch queued for re-testing.

Sorry ... just troubleshooting testbots.

Status:Needs review» Needs work
Issue tags:+Novice, +needs backport to D7

The last submitted patch, clean-up-minor-code-1326482-7.patch, failed testing.

Status:Needs work» Fixed

Automatically closed -- issue fixed for 2 weeks with no activity.

Issue summary:View changes

Added clarification.