Remove @todo comments

[seb86]

There are many comments through out the boilerplate. Some are not one liners.

[seb86]

It works but it only removes the first line if it is spaced onto more than one line. Also it leaves a blank line in place. Would be good if we can close the gap on that.

[soulseekah]

See b0cd042 might help.

[seb86]

Blank lines are now gone. Will have to improve areas where @todo is on more than one line within the boilerplate plugin for it to take full effect.

[soulseekah]

Examples?

[seb86]

What if I put something at the end of the @todo comments that have more than one line.

Example

@todo Remove both lines of this comment.
      This second line is part of the first line. #

Would that help?

[soulseekah]

That would work, but I'd suggest this instead:

@todo Remove both lines of this comment.
@todo This second line is part of the first line.

[seb86]

In the uninstall.php file there are @todo's that are like so.

/*
 * @todo Place your own uninstall code here.
 */

The generator returns those areas like this.

/*
 */

[seb86]

Example of a @todo that has more than one line.

/**
 * The WordPress.org Plugin URI.
 *
 * @todo    Replace 'your-plugin-name' with the name of the
 *          plugin slug given for your wordpress repository

As you can see the line is broken in two to prevent the developer to use soft wrap or word wrap in their editor to read it.

You are suggesting to do it like so.

/**
 * The WordPress.org Plugin URI.
 *
 * @todo    Replace 'your-plugin-name' with the name of the
 * @todo    plugin slug given for your wordpress repository

This does not look right and I'm not sure if this complies with phpDoc

So I can either change those with more than one line like so.

/**
 * The WordPress.org Plugin URI.
 *
 * @todo    Replace 'your-plugin-name' with the name of the #
 *          plugin slug given for your wordpress repository #end

Or simple put them all on one line.

/**
 * The WordPress.org Plugin URI.
 *
 * @todo    Replace 'your-plugin-name' with the name of the plugin slug given for your wordpress repository

What do you think?

[seb86]

Oh and since you did the white space cleanup. Everything is now close together. There is no line spacing anywhere between functions and variables.

[soulseekah]

Single linespaces should have been left alone. What editor are you using and which file are you viewing?

[seb86]

I'm currently using Atom and this has been applied to many, maybe even all.