Append longdesc if given synopsis on WP_CLI::add_command().#4636
Merged
schlessera merged 3 commits intomasterfrom Jan 24, 2018
Merged
Append longdesc if given synopsis on WP_CLI::add_command().#4636schlessera merged 3 commits intomasterfrom
schlessera merged 3 commits intomasterfrom
Conversation
schlessera
approved these changes
Jan 24, 2018
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related release checklist #4512 item "Document longdesc argument from #4513 in Commands Cookbook"
When attempting to do this, noticed a bug in that the
longdescarg toWP_CLI\add_command()is ignored (overwritten) if a synopsis is given as well.So this PR appends the
longdescif given to the generated synopsis.Also replaces the
PHP_EOLappends with"\n"and trims with"\r\n"asPHP_EOLshouldn't be used in this instance (tested on WIndows 10).Also adds
Utils\normalize_eols()function and uses inCompositeCommand::set_shortdesc()andset_longdesc()in case given Windows input.Also fixes the regex used to detect non-zero-length lines that aren't section headers and don't have leading spaces in
Help_Command::show_help(), which caused adding example content with a leading#to be improperly indented.