Commit c7abe577 authored by Jakob Moser's avatar Jakob Moser
Browse files

Improve documentation comment

parent 7518e129
Loading
Loading
Loading
Loading
+7 −5
Original line number Diff line number Diff line
@@ -4,12 +4,14 @@
 *
 * WordPress identifies this file by its name (which MUST be page.php).
 *
 * Pages make up the scaffolding of the website and can usually be reached via
 * different menu entries. They are expected to be always correct (or else somehow archived),
 * and the author and publication date is normally irrelevant (if anything, the date of the last edit
 * might be relevant).
 * Pages make up the scaffolding of the website and can often be reached via the page's
 * main navigation. They contain information that is not expected to cease its relevance
 * and should be kept up to date.
 * The publication date of a page is normally irrelevant, more interesting would be the date
 * of the last edit. In this template, we simply display no author names and no dates.
 * 
 * This means we neither display an author nor a date here.
 * Posts, on the other hand, have an (often implicit) expiration date and are expected to
 * cease to be relevant at some point in time. See single.php for more details.
 *
 * @see https://codex.wordpress.org/Theme_Development#Pages_.28page.php.29
 */
+9 −3
Original line number Diff line number Diff line
@@ -5,9 +5,15 @@
 * WordPress identifies this file by its name (which MUST be single.php)
 * and displays it whenever a single post is displayed.
 * 
 * Single posts display an author and a post date and are general used
 * for news articles (so a chronologically ordered list of posts makes sense,
 * you would call that a "blog").
 * Posts are generally used to present a piece of information that is relevant 
 * during a certain timespan, like a news article. After that time, the contents
 * often lose most of its relevance, aren't updated anymore (even if it means information
 * presented in a post stops to be accurate due to its old age) and kept only for
 * archival purposes.
 * Posts display an author and a post date.
 * 
 * Pages, on the other hand, contain information that is always relevant and should
 * always be kept up to date, see page.php for more.
 *
 * @see https://codex.wordpress.org/Theme_Development#Single_Post_.28single.php.29
 */