WordPress-C
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Docs: Add full parameter and return documentation for `WP_Text_Diff_Renderer_Table::interleave_changed_lines()`. 

Props coffee2code.
Fixes #38520.

Built from https://develop.svn.wordpress.org/trunk@40971


git-svn-id: http://core.svn.wordpress.org/trunk@40821 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2017-06-30 05:29:41 +00:00
parent b13aa27cf4
commit 66e6776a5e
2 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
wp-includes/class-wp-text-diff-renderer-table.php
View File

@ -319,16 +319,31 @@ class WP_Text_Diff_Renderer_Table extends Text_Diff_Renderer {
/** /**
* Takes changed blocks and matches which rows in orig turned into which rows in final. * Takes changed blocks and matches which rows in orig turned into which rows in final.
* *
* Returns
* *_matches ( which rows match with which )
* *_rows ( order of rows in each column interleaved with blank rows as
* necessary )
*
* @since 2.6.0 * @since 2.6.0
* @access public
* *
* @param array $orig * @param array $orig Lines of the original version of the text.
* @param array $final * @param array $final Lines of the final version of the text.
* @return array * @return array {
* Array containing results of comparing the original text to the final text.
*
* @type array $orig_matches Associative array of original matches. Index == row
* number of `$orig`, value == corresponding row number
* of that same line in `$final` or 'x' if there is no
* corresponding row (indicating it is a deleted line).
* @type array $final_matches Associative array of final matches. Index == row
* number of `$final`, value == corresponding row number
* of that same line in `$orig` or 'x' if there is no
* corresponding row (indicating it is a new line).
* @type array $orig_rows Associative array of interleaved rows of `$orig` with
* blanks to keep matches aligned with side-by-side diff
* of `$final`. A value >= 0 corresponds to index of `$orig`.
* Value < 0 indicates a blank row.
* @type array $final_rows Associative array of interleaved rows of `$final` with
* blanks to keep matches aligned with side-by-side diff
* of `$orig`. A value >= 0 corresponds to index of `$final`.
* Value < 0 indicates a blank row.
* }
*/ */
public function interleave_changed_lines( $orig, $final ) { public function interleave_changed_lines( $orig, $final ) {

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.9-alpha-40970'; $wp_version = '4.9-alpha-40971';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.