Skip to content

Commit

Permalink
Update property and method docblocks of theme.
Browse files Browse the repository at this point in the history
See #1313
  • Loading branch information
Levdbas committed May 20, 2023
1 parent b32340d commit 7f30f3f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions src/Theme.php
Original file line number Diff line number Diff line change
Expand Up @@ -66,13 +66,13 @@ class Theme extends Core implements JsonSerializable

/**
* @api
* @var string the slug of the theme (ex: `my-super-theme`)
* @var string the slug of the theme (ex: `my-timber-theme`)
*/
public $slug;

/**
* @api
* @var string
* @var string Retrieves template directory URI for the active (parent) theme. (ex: `http://example.org/wp-content/themes/my-timber-theme`).
*/
public $uri;

Expand All @@ -91,7 +91,7 @@ class Theme extends Core implements JsonSerializable
* @example
* ```php
* <?php
* $theme = new Timber\Theme("my-theme");
* $theme = new Timber\Theme("my-timber-theme");
* $context['theme_stuff'] = $theme;
* Timber::render('single.twig', $context);
* ```
Expand All @@ -110,10 +110,10 @@ public function __construct($slug = null)
}

/**
* Initalizes the Theme object
* Initializes the Theme object
*
* @internal
* @param string $slug of theme (eg 'twentysixteen').
* @param string $slug of theme (eg 'my-timber-theme').
*/
protected function init($slug = null)
{
Expand All @@ -134,7 +134,7 @@ protected function init($slug = null)

/**
* @api
* @return string the absolute path to the theme (ex: `http://example.org/wp-content/themes/my-timber-theme`)
* @return string Retrieves template directory URI for the active (child) theme. (ex: `http://example.org/wp-content/themes/my-timber-theme`).
*/
public function link()
{
Expand All @@ -143,7 +143,7 @@ public function link()

/**
* @api
* @return string the relative path to the theme (ex: `/wp-content/themes/my-timber-theme`)
* @return string The relative path to the theme (ex: `/wp-content/themes/my-timber-theme`).
*/
public function path()
{
Expand Down

0 comments on commit 7f30f3f

Please sign in to comment.