docs: Make UPGRADING examples more copyable #1363
Merged
Conversation
This file contains 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
In order to make these stand out more, I made them monospaced, so more copypastable.
iMacTia
requested changes
Jan 5, 2022
| `faraday` altogether as these gems usually have Faraday already in their dependencies. | ||
| `faraday` altogether as these gems usually have Faraday already in their dependencies. Example Gemfile line: | ||
| ```ruby | ||
| gem 'faraday-net_http' |
There was a problem hiding this comment.
When requiring, this should be faraday/net_http
There was a problem hiding this comment.
Unrelated: Right. I peeked in the Gemfile description, of the kwarg "require:" for gem, but it doesn't fully help the user.
https://bundler.io/v2.2/man/gemfile.5.html#REQUIRE-AS
I'll improve the documentation on "what to do in the app code".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
To improve the UPGRADING docs' usability, this change makes the examples stand out more. I made them monospaced, so as to be more copypastable.