Skip to content

Commit

Permalink
minor #1372 [live-component docs] Fix typo and format warning at top …
Browse files Browse the repository at this point in the history
…of page (srich387)

This PR was merged into the 2.x branch.

Discussion
----------

[live-component docs] Fix typo and format warning at top of page

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| Issues        | n/a
| License       | MIT

- Format the "experimental" warning as a caution box
- Fix typo in code sample ("it's" -> "its")

Commits
-------

4bd5edf Update index.rst
  • Loading branch information
kbond committed Jan 4, 2024
2 parents 86a7d39 + 4bd5edf commit 42c67a1
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions src/LiveComponent/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
Live Components
===============

**EXPERIMENTAL** This component is currently experimental and is likely
to change, or even change drastically.
.. caution::

This component is currently experimental and is likely to change, or even
change drastically.

Live components builds on top of the `TwigComponent`_ library
to give you the power to automatically update your Twig components on
Expand Down Expand Up @@ -3256,7 +3258,7 @@ uses Symfony's test client to render and make requests to your components::
// refresh the component
$testComponent->refresh();

// access the component object (in it's current state)
// access the component object (in its current state)
$component = $testComponent->component(); // MyComponent

$this->assertSame(99, $component->count);
Expand Down

0 comments on commit 42c67a1

Please sign in to comment.