<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[55646] trunk/src/wp-includes: Docs: Revise comments using {U+201C}we{U+201D} in various docblocks.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/55646">55646</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/55646","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-04-11 22:04:58 +0000 (Tue, 11 Apr 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Revise comments using {U+201C}we{U+201D} in various docblocks.
This updates some inline comments to better match the guidelines and recommendations set forth in the make/core and make/docs handbooks:
> In general, use second person in your documentation. Second person depicts a friendly tone, with a perfect focus on the reader. In addition to this, directly addressing the reader helps avoid passive voice; thereby preventing unwanted confusion. The word {U+201C}we{U+201D} should be avoided (...) unless its made very clear which group is speaking.
References:
- [https://make.wordpress.org/docs/style-guide/language-grammar/grammatical-person/ Style Guide: Grammatical person]
- [https://make.wordpress.org/docs/handbook/documentation-team-handbook/handbooks-style-and-formatting-guide/ Handbooks & HelpHub Style and Formatting Guide]
- [https://make.wordpress.org/core/handbook/best-practices/post-comment-guidelines/#style-and-substance Post & Comment Guidelines: Style and Substance]
Follow-up to <a href="https://core.trac.wordpress.org/changeset/2176">[2176]</a>, <a href="https://core.trac.wordpress.org/changeset/3430">[3430]</a>, <a href="https://core.trac.wordpress.org/changeset/4676">[4676]</a>, <a href="https://core.trac.wordpress.org/changeset/6009">[6009]</a>, <a href="https://core.trac.wordpress.org/changeset/7991">[7991]</a>, <a href="https://core.trac.wordpress.org/changeset/12688">[12688]</a>, <a href="https://core.trac.wordpress.org/changeset/12762">[12762]</a>, <a href="https://core.trac.wordpress.org/changeset/26008">[26008]</a>, <a href="https://core.trac.wordpress.org/changeset/28978">[28978]</a>, <a href="https://core.trac.wordpress.org/changeset/44488">[44488]</a>, <a href="https://core.trac.wordpress.org/changeset/44962">[44962]</a>, <a href="https://core.trac.wordpress.org/changeset/51979">[51979]</a>, <a href="https://core.trac.wordpress.org/changeset/53131">[53131]</a>, <a href="https://core.trac.wordpress.org/changeset/53132">[53132]</a>, <
a href="https://core.trac.wordpress.org/changeset/53156">[53156]</a>, <a href="https://core.trac.wordpress.org/changeset/53131">[53131]</a>, <a href="https://core.trac.wordpress.org/changeset/54200">[54200]</a>, <a href="https://core.trac.wordpress.org/changeset/54866">[54866]</a>.
Props majaloncar, leamcaleese, annebovelett.
Fixes <a href="https://core.trac.wordpress.org/ticket/57052">#57052</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpeditorphp">trunk/src/wp-includes/class-wp-editor.php</a></li>
<li><a href="#trunksrcwpincludesclasswphttpcurlphp">trunk/src/wp-includes/class-wp-http-curl.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpeditorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-editor.php 2023-04-11 16:28:51 UTC (rev 55645)
+++ trunk/src/wp-includes/class-wp-editor.php 2023-04-11 22:04:58 UTC (rev 55646)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1508,8 +1508,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Force uncompressed TinyMCE when a custom theme has been defined.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The compressed TinyMCE file cannot deal with custom themes, so this makes
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * sure that we use the uncompressed TinyMCE file if a theme is defined.
- * Even if we are on a production environment.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * sure that WordPress uses the uncompressed TinyMCE file if a theme is defined.
+ * Even if the website is running on a production environment.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpincludesclasswphttpcurlphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-http-curl.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-http-curl.php 2023-04-11 16:28:51 UTC (rev 55645)
+++ trunk/src/wp-includes/class-wp-http-curl.php 2023-04-11 22:04:58 UTC (rev 55646)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -328,8 +328,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Grabs the headers of the cURL request.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Each header is sent individually to this callback, so we append to the `$header` property
- * for temporary storage
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Each header is sent individually to this callback, and is appended to the `$header` property
+ * for temporary storage.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -345,14 +345,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Grabs the body of the cURL request.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The contents of the document are passed in chunks, so we append to the `$body`
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The contents of the document are passed in chunks, and are appended to the `$body`
</ins><span class="cx" style="display: block; padding: 0 10px"> * property for temporary storage. Returning a length shorter than the length of
</span><span class="cx" style="display: block; padding: 0 10px"> * `$data` passed in will cause cURL to abort the request with `CURLE_WRITE_ERROR`.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.6.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param resource $handle cURL handle.
- * @param string $data cURL request body.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param resource $handle cURL handle.
+ * @param string $data cURL request body.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return int Total bytes of data written.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private function stream_body( $handle, $data ) {
</span></span></pre>
</div>
</div>
</body>
</html>