Document that bundle show [--paths] sorts results
#6613
Conversation
|
Thanks for opening a pull request and helping make Bundler better! Someone from the Bundler team will take a look at your pull request shortly and leave any feedback. Please make sure that your pull request has tests for any changes or added functionality. We use Travis CI to test and make sure your change works functionally and uses acceptable conventions, you can review the current progress of Travis CI in the PR status window below. If you have any questions or concerns that you wish to ask, feel free to leave a comment in this PR or join our #bundler channel on Slack. For more information about contributing to the Bundler project feel free to review our CONTRIBUTING guide |
|
I forgot to link to the code lines that show sorting being done. Here is the line for Here is the line without |
|
Thanks! @bundlerbot r+ |
|
📌 Commit 601ae64 has been approved by |
…wandale Document that `bundle show [--paths]` sorts results ### What was the end-user problem that led to this PR? The problem was that I could not tell from the manpage or documentation website whether `bundle show` and `bundle show --paths` would list gems and gem paths in the same order. I am using `bundle show` and `bundle show --paths` to inventory gems that projects depend upon. ### What was your diagnosis of the problem? My diagnosis was that the implementation of `bundle show` _does_ sort results by name, but that the manpage for the subcommand doesn't mention this. ### What is your fix for the problem, implemented in this PR? My fix involved slightly editing the existing manpage for `bundle show`. ### Why did you choose this fix out of the possible options? I chose this fix because the `.ronn` file text matched the current text I was seeing via the documentation website.
|
☀️ Test successful - status-travis |
|
Thanks, Bundler team! The work you do is super important. |
…wandale Document that `bundle show [--paths]` sorts results ### What was the end-user problem that led to this PR? The problem was that I could not tell from the manpage or documentation website whether `bundle show` and `bundle show --paths` would list gems and gem paths in the same order. I am using `bundle show` and `bundle show --paths` to inventory gems that projects depend upon. ### What was your diagnosis of the problem? My diagnosis was that the implementation of `bundle show` _does_ sort results by name, but that the manpage for the subcommand doesn't mention this. ### What is your fix for the problem, implemented in this PR? My fix involved slightly editing the existing manpage for `bundle show`. ### Why did you choose this fix out of the possible options? I chose this fix because the `.ronn` file text matched the current text I was seeing via the documentation website. (cherry picked from commit 3a54aa9)
* 1-16-stable: Version 1.16.4 with changelog Auto merge of #6668 - eregon:fix-encoding-spec-from-6661, r=deivid-rodriguez Add encoding magic comment to gemfile spec Auto merge of #6662 - bundler:indirect/update-authors, r=colby-swandale Auto merge of #6650 - greysteil:dont-mutate-original-trees, r=segiddins Auto merge of #6661 - eregon:consistent-encoding-for-reading-files, r=deivid-rodriguez Auto merge of #6652 - bundler:seg-molinillo-0.6.6, r=segiddins Auto merge of #6645 - bundler:colby/require-etc, r=colby-swandale Auto merge of #6636 - ojab:1-16-stable, r=indirect Auto merge of #6624 - bundler:no-document, r=colby-swandale Auto merge of #6621 - ralphbolo:patch-1, r=segiddins Auto merge of #6613 - kemitchell:mention-show-sorts-in-doc, r=colby-swandale Auto merge of #6570 - akihiro17:prerelease-dependency, r=segiddins Auto merge of #6568 - greysteil:conservative-groups, r=segiddins
What was the end-user problem that led to this PR?
The problem was that I could not tell from the manpage or documentation website whether
bundle showandbundle show --pathswould list gems and gem paths in the same order.I am using
bundle showandbundle show --pathsto inventory gems that projects depend upon.What was your diagnosis of the problem?
My diagnosis was that the implementation of
bundle showdoes sort results by name, but that the manpage for the subcommand doesn't mention this.What is your fix for the problem, implemented in this PR?
My fix involved slightly editing the existing manpage for
bundle show.Why did you choose this fix out of the possible options?
I chose this fix because the
.ronnfile text matched the current text I was seeing via the documentation website.