Skip to content

Commit b06fbf7

Browse files
committed
Improve hook docs
Implementing suggestions from @DrewAPicture at bradyvercher@f324e85#commitcomment-6066540 See bradyvercher#45.
1 parent f324e85 commit b06fbf7

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

includes/class-gistpress.php

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -641,18 +641,26 @@ protected function standardize_attributes( array $rawattr ) {
641641
*
642642
* @since 2.0.0
643643
*
644+
* @see standardize_attributes()
645+
*
644646
* @param array $gistpress_shortcode_defaults {
645647
* Shortcode attributes defaults.
646648
*
647-
* @type bool $embed_stylesheet Filterable value to include style sheet or not.
648-
* @type string $file File name within gist.
649-
* @type array $highlight Lines to highlight.
650-
* @type string $highlight_color Filterable hex color code.
651-
* @type string $id Gist ID.
652-
* @type int $lines Number of lines to show.
653-
* @type int $lines_start Which line number to start from.
654-
* @type bool $show_line_numbers Show line numbers or not, default true.
655-
* @type bool $show_meta Show meta information or not, default true.
649+
* @type bool $embed_stylesheet Filterable value to include style sheet or not. Default is true
650+
* to include it.
651+
* @type string $file File name within gist. Default is an empty string, indicating
652+
* all files.
653+
* @type array $highlight Lines to highlight. Default is empty array, to highlight
654+
* no lines.
655+
* @type string $highlight_color Filterable hex color code. Default is #ffc.
656+
* @type string $id Gist ID. Non-optional.
657+
* @type string $lines Number of lines to show. Default is empty string, indicating
658+
* all lines in the gist.
659+
* @type string $lines_start Which line number to start from. Default is empty string,
660+
* indicating line number 1.
661+
* @type bool $show_line_numbers Show line numbers or not, default is true, to show line numbers.
662+
* @type bool $show_meta Show meta information or not, default is true, to show
663+
* meta information.
656664
* }
657665
*/
658666
$defaults = apply_filters(
@@ -664,18 +672,20 @@ protected function standardize_attributes( array $rawattr ) {
664672
*
665673
* @since 2.0.0
666674
*
667-
* @param bool $gistpress_stylesheet_default Default is true.
675+
* @param bool $gistpress_stylesheet_default Include default style sheet or not.
676+
* Default is true, to include it.
668677
*/
669678
'embed_stylesheet' => apply_filters( 'gistpress_stylesheet_default', true ),
670679
'file' => '',
671680
'highlight' => array(),
672681

673682
/**
674-
* Filter to set highlight color.
683+
* Filter highlight color.
675684
*
676685
* @since 2.0.0
677686
*
678-
* @param string $gistpress_highlight_color Hex color code, default is `#ffc`.
687+
* @param string $gistpress_highlight_color Hex color code for highlighting lines.
688+
* Default is `#ffc`.
679689
*/
680690
'highlight_color' => apply_filters( 'gistpress_highlight_color', '#ffc' ),
681691
'id' => '',

0 commit comments

Comments
 (0)