[wp-trac] [WordPress Trac] #53875: Update inline docs to match handbook standards
WordPress Trac
noreply at wordpress.org
Tue Oct 26 23:37:33 UTC 2021
#53875: Update inline docs to match handbook standards
-----------------------------+-----------------------------
Reporter: johnjamesjacoby | Owner: (none)
Type: defect (bug) | Status: new
Priority: normal | Milestone: Future Release
Component: General | Version:
Severity: normal | Resolution:
Keywords: | Focuses: docs
-----------------------------+-----------------------------
Changes (by sabernhardt):
* milestone: Awaiting Review => Future Release
Comment:
If we follow the single-line style, those comments could be full
sentences:
{{{
// Load WordPress Administration Bootstrap.
require_once __DIR__ . '/admin.php';
}}}
If this would include the wp-config-sample file, I think I prefer the
multi-line style for any settings there that users would edit. Then the
lines at the bottom could stand out better with the single-line style.
{{{
/* That's all, stop editing! Happy publishing. */
// Define absolute path to the WordPress directory.
if ( ! defined( 'ABSPATH' ) ) {
define( 'ABSPATH', __DIR__ . '/' );
}
// Set up WordPress vars and included files.
require_once ABSPATH . 'wp-settings.php';
}}}
--
Ticket URL: <https://core.trac.wordpress.org/ticket/53875#comment:3>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list