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

Add caller information to some deprecation messages #7361

Merged
1 commit merged into from Sep 27, 2019

Conversation

deivid-rodriguez
Copy link
Member

@deivid-rodriguez deivid-rodriguez commented Sep 23, 2019

What was the end-user problem that led to this PR?

The problem was that some deprecations mention usage of deprecated methods, but include no information about where the deprecated method is being called.

What was your diagnosis of the problem?

My diagnosis was that we should include this information with this kind of deprecation messages, to make migration easier.

What is your fix for the problem, implemented in this PR?

My fix is to add an optional argument to the major_deprecation method, to print the location of the deprecated caller.

Why did you choose this fix out of the possible options?

I chose this fix because it required little code changes.

Some deprecations would be fixed more easily if they included the
location where the deprecated method was called.
@deivid-rodriguez deivid-rodriguez added this to the 2.1.0.pre.3 milestone Sep 23, 2019
@deivid-rodriguez deivid-rodriguez requested a review from indirect Sep 25, 2019
@indirect
Copy link
Member

indirect commented Sep 27, 2019

What a good idea 😅

@indirect
Copy link
Member

indirect commented Sep 27, 2019

@bundlerbot r+

ghost pushed a commit that referenced this issue Sep 27, 2019
7361: Add caller information to some deprecation messages r=indirect a=deivid-rodriguez

### What was the end-user problem that led to this PR?

The problem was that some deprecations mention usage of deprecated methods, but include no information about where the deprecated method is being called.

### What was your diagnosis of the problem?

My diagnosis was that we should include this information with this kind of deprecation messages, to make migration easier.

### What is your fix for the problem, implemented in this PR?

My fix is to add an optional argument to the `major_deprecation` method, to print the location of the deprecated caller.

### Why did you choose this fix out of the possible options?

I chose this fix because it required little code changes.


Co-authored-by: David Rodríguez <deivid.rodriguez@riseup.net>
@ghost
Copy link

ghost commented Sep 27, 2019

Build succeeded

@ghost ghost merged commit 7516416 into master Sep 27, 2019
4 checks passed
@ghost ghost deleted the add_info_to_some_deprecation_messages branch Sep 27, 2019
deivid-rodriguez pushed a commit that referenced this issue Nov 7, 2019
7361: Add caller information to some deprecation messages r=indirect a=deivid-rodriguez

### What was the end-user problem that led to this PR?

The problem was that some deprecations mention usage of deprecated methods, but include no information about where the deprecated method is being called.

### What was your diagnosis of the problem?

My diagnosis was that we should include this information with this kind of deprecation messages, to make migration easier.

### What is your fix for the problem, implemented in this PR?

My fix is to add an optional argument to the `major_deprecation` method, to print the location of the deprecated caller.

### Why did you choose this fix out of the possible options?

I chose this fix because it required little code changes.

Co-authored-by: David Rodríguez <deivid.rodriguez@riseup.net>
(cherry picked from commit e719a58)
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

2 participants