Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Use Doctor RST 1.41.0 and new rule TitleUnderlineLengthMustMatchTitleLength #18026

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

Merged
merged 1 commit into from
Mar 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .doctor-rst.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ rules:
space_between_label_and_link_in_doc: ~
space_between_label_and_link_in_ref: ~
string_replacement: ~
title_underline_length_must_match_title_length: ~
typo: ~
unused_links: ~
use_deprecated_directive_instead_of_versionadded: ~
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ jobs:
key: ${{ runner.os }}-doctor-rst-${{ steps.extract_base_branch.outputs.branch }}

- name: "Run DOCtor-RST"
uses: docker://oskarstark/doctor-rst:1.40.1
uses: docker://oskarstark/doctor-rst:1.41.0
with:
args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache

Expand Down
4 changes: 2 additions & 2 deletions best_practices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ important parts of your application.
.. _best-practice-controller-annotations:

Use Attributes or Annotations to Configure Routing, Caching, and Security
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Using attributes or annotations for routing, caching, and security simplifies
configuration. You don't need to browse several files created with different
Expand Down Expand Up @@ -445,7 +445,7 @@ specific tests for each page.
.. _hardcode-urls-in-a-functional-test:

Hard-code URLs in a Functional Test
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In Symfony applications, it's recommended to :ref:`generate URLs <routing-generating-urls>`
using routes to automatically update all links when a URL changes. However, if a
Expand Down
2 changes: 1 addition & 1 deletion components/lock.rst
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ method can be safely called repeatedly, even if the lock is already acquired.
third argument of the ``createLock()`` method to ``false``.

Serializing Locks
------------------
-----------------

The :class:`Symfony\\Component\\Lock\\Key` contains the state of the
:class:`Symfony\\Component\\Lock\\Lock` and can be serialized. This
Expand Down
2 changes: 1 addition & 1 deletion components/runtime.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
single: Components; Runtime

The Runtime Component
======================
=====================

The Runtime Component decouples the bootstrapping logic from any global state
to make sure the application can run with runtimes like PHP-PM, ReactPHP,
Expand Down
2 changes: 1 addition & 1 deletion components/serializer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1069,7 +1069,7 @@ context to pass in these options using the key ``json_encode_options`` or
$this->serializer->serialize($data, 'json', ['json_encode_options' => \JSON_PRESERVE_ZERO_FRACTION]);

The ``CsvEncoder``
~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~

The ``CsvEncoder`` encodes to and decodes from CSV.

Expand Down
2 changes: 1 addition & 1 deletion controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ to render the content of a page.
single: Controller; Basic example

A Basic Controller
-------------------
------------------

While a controller can be any PHP callable (function, method on an object,
or a ``Closure``), a controller is usually a method inside a controller
Expand Down
2 changes: 1 addition & 1 deletion frontend/encore/bootstrap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Now, require bootstrap from any of your JavaScript files:
});

Using Bootstrap with Turbo
---------------------------
--------------------------

If you are using bootstrap with Turbo Drive, to allow your JavaScript to load on each page change,
wrap the initialization in a ``turbo:load`` event listener:
Expand Down
2 changes: 1 addition & 1 deletion frontend/encore/virtual-machine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ connections:
otherwise other computers can have access to it.

Fix "Invalid Host header" Issue
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Webpack will respond ``Invalid Host header`` when trying to access files from
the dev-server. To fix this, set the ``allowedHosts`` option:
Expand Down
2 changes: 1 addition & 1 deletion mercure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -614,7 +614,7 @@ Checkout `the dedicated API Platform documentation`_ to learn more about
its Mercure support.

Testing
--------
-------

During unit testing it's usually not needed to send updates to Mercure.

Expand Down
2 changes: 1 addition & 1 deletion reference/configuration/framework.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1227,7 +1227,7 @@ The value of this option is an associative array of ``domain => IP address``
(e.g ``['symfony.com' => '46.137.106.254', ...]``).

retry_strategy
...............
..............

**type**: ``string``

Expand Down
2 changes: 1 addition & 1 deletion reference/configuration/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -413,7 +413,7 @@ If ``true``, users are always redirected to the default target path regardless
of the previous URL that was stored in the session.

default_target_path
....................
...................

**type**: ``string`` **default**: ``/``

Expand Down
2 changes: 1 addition & 1 deletion reference/forms/types/choice.rst
Original file line number Diff line number Diff line change
Expand Up @@ -318,7 +318,7 @@ Field Variables
faster to use the :ref:`selectedchoice <form-twig-selectedchoice>` test.

Accessing Form Choice Data
...........................
..........................

The ``form.vars`` variable of each choice entry holds data such as whether the
choice is selected or not. If you need to get the full list of choices data and
Expand Down
2 changes: 1 addition & 1 deletion reference/forms/types/tel.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
single: Forms; Fields; TelType

TelType Field
===============
=============

The ``TelType`` field is a text field that is rendered using the HTML5
``<input type="tel">`` tag. Following the recommended HTML5 behavior, the value
Expand Down
2 changes: 1 addition & 1 deletion reference/twig_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ and :ref:`reference-assets-json-manifest-path` configuration options.
Read more about :ref:`linking to web assets from templates <templates-link-to-assets>`.

asset_version
~~~~~~~~~~~~~~
~~~~~~~~~~~~~

.. code-block:: twig

Expand Down