Clean up code comments.

[benjifisher]

Even after the code cleanup in PR #5, I see this documentation block in src/Typogrify.php:

  /**
   * initial_quotes.
   *
   * Wraps initial quotes in ``class="dquo"`` for double quotes or
   * ``class="quo"`` for single quotes. Works in these block tags ``(h1-h6, p, li)``
   * and also accounts for potential opening inline elements ``a, em, strong, span, b, i``
   * Optionally choose to apply quote span tags to Gullemets as well.
   */
  public static function initial_quotes($text, $do_guillemets = false) {

The first line should be a single sentence that describes the function. The rest should be wrapped to 80 characters. I do not know if we care about the double backticks.

[jpamental]

We do! That's part of the explanation of what this does! I can help go through that and clean up stuff like that.

You can leave that for now.

On Sep 22, 2016, at 12:38 AM, Benji Fisher notifications@github.com wrote:

Even after the code cleanup in PR #5, I see this documentation block in src/Typogrify.php:

/**

• initial_quotes. *
• Wraps initial quotes in class="dquo" for double quotes or
• class="quo" for single quotes. Works in these block tags (h1-h6, p, li)
• and also accounts for potential opening inline elements a, em, strong, span, b, i
• Optionally choose to apply quote span tags to Gullemets as well. */ public static function initial_quotes($text, $do_guillemets = false) { The first line should be a single sentence that describes the function. The rest should be wrapped to 80 characters. I do not know if we care about the double backticks.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or mute the thread.