Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation in comments at the top of files. #781

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions 404.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
/**
* The template for displaying 404 pages (not found).
*
* @link https://codex.wordpress.org/Creating_an_Error_404_Page
*
* @package _s
*/

Expand Down
2 changes: 1 addition & 1 deletion archive.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
/**
* The template for displaying archive pages.
*
* Learn more: http://codex.wordpress.org/Template_Hierarchy
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
Expand Down
4 changes: 3 additions & 1 deletion comments.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,11 @@
/**
* The template for displaying comments.
*
* The area of the page that contains both current comments
* This is the template that displays the area of the page that contains both the current comments
* and the comment form.
*
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/

Expand Down
4 changes: 3 additions & 1 deletion footer.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
/**
* The template for displaying the footer.
*
* Contains the closing of the #content div and all content after
* Contains the closing of the #content div and all content after.
*
* @link https://developer.wordpress.org/themes/basics/template-files/#template-partials
*
* @package _s
*/
Expand Down
4 changes: 3 additions & 1 deletion functions.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<?php
/**
* _s functions and definitions
* _s functions and definitions.
*
* @link https://codex.wordpress.org/Functions_File_Explained
*
* @package _s
*/
Expand Down
4 changes: 3 additions & 1 deletion header.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@
/**
* The header for our theme.
*
* Displays all of the <head> section and everything up till <div id="content">
* This is the template that displays all of the <head> section and everything up until <div id="content">
*
* @link https://developer.wordpress.org/themes/basics/template-files/#template-partials
*
* @package _s
*/
Expand Down
5 changes: 3 additions & 2 deletions inc/custom-header.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?php
/**
* Sample implementation of the Custom Header feature
* http://codex.wordpress.org/Custom_Headers
* Sample implementation of the Custom Header feature.
*
* You can add an optional custom header image to header.php like so ...
*
Expand All @@ -11,6 +10,8 @@
</a>
<?php endif; // End header image check. ?>
*
* @link http://codex.wordpress.org/Custom_Headers
*
* @package _s
*/

Expand Down
2 changes: 1 addition & 1 deletion inc/customizer.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?php
/**
* _s Theme Customizer
* _s Theme Customizer.
*
* @package _s
*/
Expand Down
4 changes: 2 additions & 2 deletions inc/extras.php
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php
/**
* Custom functions that act independently of the theme templates
* Custom functions that act independently of the theme templates.
*
* Eventually, some of the functionality here could be replaced by core features
* Eventually, some of the functionality here could be replaced by core features.
*
* @package _s
*/
Expand Down
5 changes: 3 additions & 2 deletions inc/jetpack.php
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
<?php
/**
* Jetpack Compatibility File
* See: https://jetpack.me/
* Jetpack Compatibility File.
*
* @link https://jetpack.me/
*
* @package _s
*/
Expand Down
3 changes: 2 additions & 1 deletion index.php
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
* and one of the two required files for a theme (the other being style.css).
* It is used to display a page when nothing more specific matches a query.
* E.g., it puts together the home page when no home.php file exists.
* Learn more: http://codex.wordpress.org/Template_Hierarchy
*
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
Expand Down
2 changes: 2 additions & 0 deletions js/customizer.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/**
* customizer.js
*
* Theme Customizer enhancements for a better user experience.
*
* Contains handlers to make Theme Customizer preview reload changes asynchronously.
Expand Down
7 changes: 7 additions & 0 deletions js/skip-link-focus-fix.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
/**
* skip-link-focus-fix.js
*
* Helps with accesability for keyboard only users.
*
* Learn more: https://github.com/Automattic/_s/pull/136
*/
( function() {
var is_webkit = navigator.userAgent.toLowerCase().indexOf( 'webkit' ) > -1,
is_opera = navigator.userAgent.toLowerCase().indexOf( 'opera' ) > -1,
Expand Down
7 changes: 5 additions & 2 deletions layouts/content-sidebar.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
/*
Theme Name: _s
Layout: Content-Sidebar
* Theme Name: _s
*
* Layout: Content-Sidebar
*
* Learn more: https://developer.wordpress.org/themes/basics/template-files/
*/

.content-area {
Expand Down
7 changes: 5 additions & 2 deletions layouts/sidebar-content.css
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
/*
Theme Name: _s
Layout: Sidebar-Content
* Theme Name: _s
*
* Layout: Sidebar-Content
*
* Learn more: https://developer.wordpress.org/themes/basics/template-files/
*/

.content-area {
Expand Down
4 changes: 3 additions & 1 deletion page.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@
*
* This is the template that displays all pages by default.
* Please note that this is the WordPress construct of pages
* and that other 'pages' on your WordPress site will use a
* and that other 'pages' on your WordPress site may use a
* different template.
*
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/

Expand Down
2 changes: 2 additions & 0 deletions search.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
/**
* The template for displaying search results pages.
*
* @link https://developer.wordpress.org/themes/basics/template-hierarchy/#search-result
*
* @package _s
*/

Expand Down
2 changes: 2 additions & 0 deletions sidebar.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
/**
* The sidebar containing the main widget area.
*
* @link https://developer.wordpress.org/themes/basics/template-files/#template-partials
*
* @package _s
*/

Expand Down
2 changes: 2 additions & 0 deletions single.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
/**
* The template for displaying all single posts.
*
* @link https://developer.wordpress.org/themes/basics/template-hierarchy/#single-post
*
* @package _s
*/

Expand Down
4 changes: 2 additions & 2 deletions template-parts/content-none.php
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php
/**
* The template part for displaying a message that posts cannot be found.
* Template part for displaying a message that posts cannot be found.
*
* Learn more: http://codex.wordpress.org/Template_Hierarchy
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
Expand Down
4 changes: 3 additions & 1 deletion template-parts/content-page.php
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
<?php
/**
* The template used for displaying page content in page.php
* Template part for displaying page content in page.php.
*
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
Expand Down
4 changes: 2 additions & 2 deletions template-parts/content-search.php
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<?php
/**
* The template part for displaying results in search pages.
* Template part for displaying results in search pages.
*
* Learn more: http://codex.wordpress.org/Template_Hierarchy
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/
Expand Down
2 changes: 2 additions & 0 deletions template-parts/content-single.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
/**
* Template part for displaying single posts.
*
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/

Expand Down
2 changes: 2 additions & 0 deletions template-parts/content.php
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
/**
* Template part for displaying posts.
*
* @link https://codex.wordpress.org/Template_Hierarchy
*
* @package _s
*/

Expand Down