Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 9d65156

Browse filesBrowse files
committed
minor #17802 [Refs] Fixed refs displaying incorrectly (alexandre-daubois)
This PR was merged into the 5.4 branch. Discussion ---------- [Refs] Fixed refs displaying incorrectly Some refs are displayed incorrectly with a `[1]_`, in https://symfony.com/doc/5.4/components/lock.html#the-owner-of-the-lock and https://symfony.com/doc/5.4/contributing/code/core_team.html. This aims to fix this. Commits ------- 175908e [Refs] Fixed refs displaying incorrectly
2 parents bc121fb + 175908e commit 9d65156
Copy full SHA for 9d65156

File tree

2 files changed

+15
-6
lines changed
Filter options

2 files changed

+15
-6
lines changed

‎components/lock.rst

Copy file name to clipboardExpand all lines: components/lock.rst
+6-2Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -310,7 +310,7 @@ will fallback to a write lock by calling the ``acquire()`` method.
310310
The Owner of The Lock
311311
---------------------
312312

313-
Locks that are acquired for the first time are owned [1]_ by the ``Lock`` instance that acquired
313+
Locks that are acquired for the first time are :ref:`owned <lock-owner-technical-details>` by the ``Lock`` instance that acquired
314314
it. If you need to check whether the current ``Lock`` instance is (still) the owner of
315315
a lock, you can use the ``isAcquired()`` method::
316316

@@ -347,7 +347,11 @@ lose the lock it acquired automatically::
347347
you have to use ``acquire()`` for this. The ``isAcquired()`` method is used to check
348348
if the lock has been acquired by the **current process** only.
349349

350-
.. [1] Technically, the true owners of the lock are the ones that share the same instance of ``Key``,
350+
.. _lock-owner-technical-details:
351+
352+
.. note::
353+
354+
Technically, the true owners of the lock are the ones that share the same instance of ``Key``,
351355
not ``Lock``. But from a user perspective, ``Key`` is internal and you will likely only be working
352356
with the ``Lock`` instance so it's easier to think of the ``Lock`` instance as being the one that
353357
is the owner of the lock.

‎contributing/code/core_team.rst

Copy file name to clipboardExpand all lines: contributing/code/core_team.rst
+9-4Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Pull Request Merging Policy
146146

147147
A pull request **can be merged** if:
148148

149-
* It is a minor change [1]_;
149+
* It is a :ref:`minor change <core-team_minor-changes>`;
150150

151151
* Enough time was given for peer reviews;
152152

@@ -162,7 +162,8 @@ Pull Request Merging Process
162162
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
163163

164164
All code must be committed to the repository through pull requests, except for
165-
minor changes [1]_ which can be committed directly to the repository.
165+
:ref:`minor change <core-team_minor-changes>` which can be committed directly
166+
to the repository.
166167

167168
**Mergers** must always use the command-line ``gh`` tool provided by the
168169
**Project Leader** to merge the pull requests.
@@ -178,8 +179,12 @@ Symfony Core Rules and Protocol Amendments
178179
The rules described in this document may be amended at any time at the
179180
discretion of the **Project Leader**.
180181

181-
.. [1] Minor changes comprise typos, DocBlock fixes, code standards
182-
violations, and minor CSS, JavaScript and HTML modifications.
182+
.. _core-team_minor-changes:
183+
184+
.. note::
185+
186+
Minor changes comprise typos, DocBlock fixes, code standards
187+
violations, and minor CSS, JavaScript and HTML modifications.
183188

184189
.. _`symfony-docs repository`: https://github.com/symfony/symfony-docs
185190
.. _`fabpot`: https://github.com/fabpot/

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.