Skip to content
This repository has been archived by the owner. It is now read-only.

Add inline RDoc documentation #7394

Merged
2 commits merged into from Nov 6, 2019
Merged

Conversation

zverok
Copy link
Contributor

@zverok zverok commented Oct 26, 2019

Since Bundler became part of the standard library, it renders in Ruby's docs. Unfortunately, what renders there... is not really helpful: https://docs.ruby-lang.org/en/master/Bundler.html

I've added rudimentary documentation for Bundler module and two of its most user-facing methods to solve this problem at least partially.

@welcome
Copy link

welcome bot commented Oct 26, 2019

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

@hsbt
Copy link
Member

hsbt commented Oct 29, 2019

👍

Does anyone proofread this doc?

Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Docs added look good to me, thanks for doing that.

I added a couple of small comments.

lib/bundler.rb Show resolved Hide resolved
lib/bundler/lockfile_parser.rb Show resolved Hide resolved
@hsbt
Copy link
Member

hsbt commented Nov 6, 2019

@bundlerbot merge

@hsbt hsbt added this to the 2.1.0.pre.3 milestone Nov 6, 2019
ghost pushed a commit that referenced this issue Nov 6, 2019
7394: Add inline RDoc documentation r=hsbt a=zverok

Since Bundler became part of the standard library, it renders in Ruby's docs. Unfortunately, what renders there...  is not really helpful: https://docs.ruby-lang.org/en/master/Bundler.html

I've added rudimentary documentation for `Bundler` module and two of its most user-facing methods to solve this problem at least partially.

Co-authored-by: zverok <zverok.offline@gmail.com>
@ghost
Copy link

ghost commented Nov 6, 2019

Build succeeded

@ghost ghost merged commit 9e0641e into rubygems:master Nov 6, 2019
3 checks passed
@zverok zverok deleted the rdoc-documentation branch Nov 6, 2019
deivid-rodriguez pushed a commit that referenced this issue Nov 7, 2019
7394: Add inline RDoc documentation r=hsbt a=zverok

Since Bundler became part of the standard library, it renders in Ruby's docs. Unfortunately, what renders there...  is not really helpful: https://docs.ruby-lang.org/en/master/Bundler.html

I've added rudimentary documentation for `Bundler` module and two of its most user-facing methods to solve this problem at least partially.

Co-authored-by: zverok <zverok.offline@gmail.com>
(cherry picked from commit a7cc4ec)
hsbt added a commit to hsbt/ruby that referenced this issue Nov 11, 2019
  Features:
    - Add caller information to some deprecation messages to make them easier to fix [#7361](rubygems/bundler#7361)
    - Reconcile `bundle cache` vs `bundle package` everywhere. Now in docs, CLI help and everywhere else `bundle cache` is the preferred version and `bundle package` remains as an alias [#7389](rubygems/bundler#7389)
    - Display some basic `bundler` documentation together with ruby's RDoc based documentation [#7394](rubygems/bundler#7394)

  Bugfixes:
    - Fix typos deprecation message and upgrading docs [#7374](rubygems/bundler#7374)
    - Deprecation warnings about `taint` usage on ruby 2.7 [#7385](rubygems/bundler#7385)
    - Fix `--help` flag not correctly delegating to `man` when used with command aliases [#7388](rubygems/bundler#7388)
    - `bundle add` should cache newly added gems if an application cache exists [#7393](rubygems/bundler#7393)
    - Stop using an insecure folder as a "fallback home" when user home is not defined [#7416](rubygems/bundler#7416)
    - Fix `bundler/inline` warning about `Bundler.root` redefinition [#7417](rubygems/bundler#7417)
hsbt added a commit to ruby/ruby that referenced this issue Nov 11, 2019
  Features:
    - Add caller information to some deprecation messages to make them easier to fix [#7361](rubygems/bundler#7361)
    - Reconcile `bundle cache` vs `bundle package` everywhere. Now in docs, CLI help and everywhere else `bundle cache` is the preferred version and `bundle package` remains as an alias [#7389](rubygems/bundler#7389)
    - Display some basic `bundler` documentation together with ruby's RDoc based documentation [#7394](rubygems/bundler#7394)

  Bugfixes:
    - Fix typos deprecation message and upgrading docs [#7374](rubygems/bundler#7374)
    - Deprecation warnings about `taint` usage on ruby 2.7 [#7385](rubygems/bundler#7385)
    - Fix `--help` flag not correctly delegating to `man` when used with command aliases [#7388](rubygems/bundler#7388)
    - `bundle add` should cache newly added gems if an application cache exists [#7393](rubygems/bundler#7393)
    - Stop using an insecure folder as a "fallback home" when user home is not defined [#7416](rubygems/bundler#7416)
    - Fix `bundler/inline` warning about `Bundler.root` redefinition [#7417](rubygems/bundler#7417)
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants