[Lock] Make various changes/updates on the Lock docs #17413
Conversation
|
I'd like to merge the two docs about Lock, is it still something we what to do overall? |
Yes. Moving as much of the docs to the main guide is still something we agree on as far as I know. What is still a bit unsure is where the "this is how you set-up the component outside the framework" docs need to be (component doc? minor section in main guide? component's README?) |
|
From what I understand, we've already moved "smaller" component docs to the README files. I think that's a good strategy. |
| @@ -81,57 +81,57 @@ continue the job in another process using the same lock:: | |||
| use Symfony\Component\Lock\Lock; | |||
|
|
|||
| $key = new Key('article.'.$article->getId()); | |||
| $lock = new Lock($key, $this->store, 300, false); | |||
| $lock = new Lock($key, $this->store, autoRelease: false); | |||
There was a problem hiding this comment.
Given our BC promise doesn't guarantee BC for named arguments, do we want to use them in the documentation?
There was a problem hiding this comment.
I did it as I found it easier to understand. I suppose people are using them anyway, so why not use them in the docs. I can revert if you think it would send a signal that they are part of the BC promise.
Not sure about the version, it's really up to you. |
|
@wouterj I tried to merge this in 5.4 but I faced too many conflicts. If you have some time, please try to merge this yourself. Thanks! |
|
Rebased and merged in #17465 Thanks Fabien! |
No description provided.