Skip to content

Use DOCtor-RST 1.38.2 #17858

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
Feb 3, 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
2 changes: 1 addition & 1 deletion .doctor-rst.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@ rules:
versionadded_directive_should_have_version: ~
yaml_instead_of_yml_suffix: ~
yarn_dev_option_at_the_end: ~
no_merge_conflict:

# master
versionadded_directive_major_version:
Expand Down Expand Up @@ -88,7 +89,6 @@ whitelist:
- '"foo",' # assertion for var_dumper - components/var_dumper.rst
- '$var .= "Because of this `\xE9` octet (\\xE9),\n";'
- '.. versionadded:: 0.2' # MercureBundle
- '.. code-block:: twig'
- '.. versionadded:: 3.6' # MonologBundle
- '.. versionadded:: 3.8' # MonologBundle
- '// bin/console'
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.35.1
uses: docker://oskarstark/doctor-rst:1.38.2
with:
args: --short --error-format=github --cache-file=/github/workspace/.cache/doctor-rst.cache

Expand Down
4 changes: 2 additions & 2 deletions frontend/encore/simple-example.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ To build the assets, run the following if you use the Yarn package manager:
$ yarn dev-server
# or
$ npm run dev-server

# compile assets once
$ yarn dev
# or
Expand Down Expand Up @@ -229,7 +229,7 @@ to initialize Stimulus and automatically load any "controllers" from the

Let's look at a simple Stimulus example. In a Twig template, suppose you have:

.. code-block:: twig
.. code-block:: html+twig

<div {{ stimulus_controller('say-hello') }}>
<input type="text" {{ stimulus_target('say-hello', 'name') }}>
Expand Down
2 changes: 1 addition & 1 deletion frontend/ux.rst
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ controller available! In this example, it's called
into the ``{{ stimulus_controller() }}`` function from WebpackEncoreBundle, and
it will normalize it:

.. code-block:: twig
.. code-block:: html+twig

<div {{ stimulus_controller('@symfony/ux-chartjs/chart') }}>

Expand Down
10 changes: 5 additions & 5 deletions mercure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ Subscribing

Subscribing to updates in JavaScript from a Twig template is straightforward:

.. code-block:: twig
.. code-block:: html+twig

<script>
const eventSource = new EventSource("{{ mercure('https://example.com/books/1')|escape('js') }}");
Expand All @@ -278,7 +278,7 @@ parameters corresponding to the topics passed as first argument.
If you want to access to this URL from an external JavaScript file, generate the
URL in a dedicated HTML element:

.. code-block:: twig
.. code-block:: html+twig

<script type="application/json" id="mercure-url">
{{ mercure('https://example.com/books/1')|json_encode(constant('JSON_UNESCAPED_SLASHES') b-or constant('JSON_HEX_TAG'))|raw }}
Expand All @@ -296,7 +296,7 @@ Mercure also allows subscribing to several topics,
and to use URI Templates or the special value ``*`` (matched by all topics)
as patterns:

.. code-block:: twig
.. code-block:: html+twig

<script>
{# Subscribe to updates of several Book resources and to all Review resources matching the given pattern #}
Expand Down Expand Up @@ -427,7 +427,7 @@ passed by the browsers to the Mercure hub if the ``withCredentials`` attribute
of the ``EventSource`` class is set to ``true``. Then, the Hub verifies the
validity of the provided JWT, and extract the topic selectors from it.

.. code-block:: twig
.. code-block:: html+twig

<script>
const eventSource = new EventSource("{{ mercure('https://example.com/books/1', { subscribe: 'https://example.com/books/1' })|escape('js') }}", {
Expand Down Expand Up @@ -455,7 +455,7 @@ is the way to go.
The native implementation of EventSource doesn't allow specifying headers.
For example, authorization using a Bearer token. In order to achieve that, use `a polyfill`_

.. code-block:: twig
.. code-block:: html+twig

<script>
const es = new EventSourcePolyfill("{{ mercure('https://example.com/books/1') }}", {
Expand Down