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

Proofread upgrade guide #4384

Merged
merged 1 commit into from
Oct 24, 2020
Merged

Conversation

greg0ire
Copy link
Member

No description provided.

@greg0ire greg0ire changed the base branch from 2.12.x to 3.0.x October 23, 2020 20:48
@greg0ire greg0ire requested a review from morozov October 23, 2020 20:48
UPGRADE.md Outdated
@@ -200,7 +199,7 @@ The `Doctrine\DBAL\Driver::getName()` has been removed.

## BC BREAK changes the `Driver::connect()` signature

The method no longer accepts the `$username`, `$password` and `$driverOptions` arguments. The corresponding values are expected to be passed as the "user", "password" and "driver_options" keys of the `$params` argument respectively.
The method no longer accepts the `$username`, `$password` and `$driverOptions` arguments. The corresponding values are expected to be passed as the `user`, `password` and `driver_options` keys of the `$params` argument respectively.
Copy link
Member

Choose a reason for hiding this comment

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

These are not symbols but strings. I'd format them as "user", etc.

Copy link
Member Author

Choose a reason for hiding this comment

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

IMO array keys still deserve that formatting, especially since driver_options contains an underscore, but also because the user will get an issue if they misspell these strings.

Copy link
Member

Choose a reason for hiding this comment

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

I meant both formatting as code and quotes.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh ok, let's do this!

Copy link
Member

@morozov morozov Oct 24, 2020

Choose a reason for hiding this comment

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

I spent 5 minutes before answering, googling how to represent a backtick as code in markdown and gave up, although I remember I found a solution earlier.

Copy link
Member Author

@greg0ire greg0ire Oct 24, 2020

Choose a reason for hiding this comment

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

You can edit my message to see how

`"hi"`

This is where I found it: https://meta.stackexchange.com/questions/82718/how-do-i-escape-a-backtick-within-in-line-code-in-markdown

Copy link
Member

Choose a reason for hiding this comment

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

How fun is it? This is the article I had found earlier!

@greg0ire greg0ire merged commit 3becaec into doctrine:3.0.x Oct 24, 2020
@greg0ire greg0ire deleted the proofread-upgrade-guide branch October 24, 2020 16:18
@morozov
Copy link
Member

morozov commented Oct 24, 2020

Thanks, @greg0ire, for the cleanup 👍

@greg0ire greg0ire added this to the 3.0.0 milestone Oct 24, 2020
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants