Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update bundle-exec man page to not use deprecated Bundler.with_clean_env #6284

Conversation

technicalpickles
Copy link
Contributor

with_clean_env has been deprecated in with_unbundled_env. It already generates a deprecation warning when it uses, but this man page was still referring to it.

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

If a user follows the instructions from bundle exec --help and uses Bundler.with_clean_env, they will get a deprecated message to use Bundler.with_unbundled_env

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

Update the .ronn and .man pages

Make sure the following tasks are checked

Copy link
Member

@deivid-rodriguez deivid-rodriguez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably document Bundler.with_original_env, and the differences between the two (in my experience Bundler.with_original_env is normally what users want).

But this first pass replacing the deprecated helper with the non-deprecated equivalent already improves things, so good to go as is!

`with_clean_env` has been deprecated in `with_unbundled_env`. It already generates a deprecation warning when it uses, but this man page was still referring to it.
@deivid-rodriguez deivid-rodriguez changed the title Update bundle-exec man page for with_unbundled_env Update bundle-exec man page to not use deprecated Bundler.with_clean_env Jan 20, 2023
@deivid-rodriguez deivid-rodriguez merged commit 0688951 into rubygems:master Jan 20, 2023
@technicalpickles technicalpickles deleted the bundle-with-unbundled-env-docs branch January 20, 2023 15:40
deivid-rodriguez added a commit that referenced this pull request Jan 21, 2023
…env-docs

Update bundle-exec man page for  with_unbundled_env

(cherry picked from commit 0688951)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants