Skip to content

Proofread upgrade guide#4384

Merged
greg0ire merged 1 commit intodoctrine:3.0.xfrom
greg0ire:proofread-upgrade-guide
Oct 24, 2020
Merged

Proofread upgrade guide#4384
greg0ire merged 1 commit intodoctrine:3.0.xfrom
greg0ire:proofread-upgrade-guide

Conversation

@greg0ire
Copy link
Copy Markdown
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
## 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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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
Copy Markdown
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 force-pushed the proofread-upgrade-guide branch from fd2cf14 to 22a95b2 Compare October 24, 2020 15:43
@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
Copy Markdown
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