Download & Extend
Issues

Clean up minor code style issues in archiver.inc

Posted by xjm on October 30, 2011 at 2:03pm
Project:Drupal core
Version:8.x-dev
Component:documentation
Category:task
Priority:minor
Assigned:ryanissamson
Status:closed (fixed)
Issue tags:needs backport to D7, Novice

Issue Summary

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.

Login or register to post comments

Comments

#1

Posted by xjm on October 30, 2011 at 2:04pm
Status:active» postponed

#2

Posted by xjm on October 30, 2011 at 2:19pm

This is probably unobtrusive enough to backport.

#3

Posted by xjm on October 30, 2011 at 2:26pm
Assigned to:Anonymous» xjm

#4

Posted by xjm on October 30, 2011 at 2:27pm
Priority:normal» minor

#5

Posted by xjm on October 30, 2011 at 2:34pm
Assigned to:xjm» Anonymous
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.

#6

Posted by ryanissamson on January 31, 2012 at 5:17am
Assigned to:Anonymous» ryanissamson

I can do this one :)

#7

Posted by ryanissamson on January 31, 2012 at 6:31am
Status:postponed» needs review

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.

AttachmentSizeStatusTest resultOperations
clean-up-minor-code-1326482-7.patch698 bytesIdleFAILED: [[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 details

#8

Posted by tregeagle on January 31, 2012 at 7:30am
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...

#9

Posted by webchick on January 31, 2012 at 10:53am
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

#10

Posted by jthorson on February 1, 2012 at 4:49am
Status:fixed» needs review

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

Sorry ... just troubleshooting testbots.

#11

Posted by System Message on February 1, 2012 at 4:50am
Status:needs review» needs work

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

#12

Posted by jthorson on February 1, 2012 at 4:52am
Status:needs work» fixed

#13

Posted by System Message on February 15, 2012 at 5:00am
Status:fixed» closed (fixed)

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

nobody click here