Skip to content

Commit 0379633

Browse files
committed
fix misc examples + remove known issues section
1 parent 0bf97e3 commit 0379633

7 files changed

+16
-22
lines changed

docs/source/examples.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,7 @@ Assuming you already installed ``semantic-ui-react`` as in the :ref:`Install Jav
213213

214214
.. literalinclude:: examples/primary_secondary_buttons.py
215215

216-
Move the slider and see the event information update 👇
216+
Click the buttons and see the event information update 👇
217217

218218
.. interactive-widget:: primary_secondary_buttons
219219

docs/source/examples/material_ui_slider.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ def SliderOnPaper():
3131
"onChange": lambda *event: set_event(event),
3232
}
3333
),
34-
json.dumps(event, indent=2),
34+
idom.html.pre(json.dumps(event, indent=2)),
3535
)
3636

3737

docs/source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ Libraries for defining and controlling interactive webpages with Python
1818
specifications
1919
extra-features
2020
examples
21-
known-issues
2221
api
2322

2423

docs/source/installation.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The test suite for IDOM is executed using Tox_ and covers:
8787

8888
2. The end-to-end application using Selenium_
8989

90-
3. (Coming soon...) Client side Javascript code [GH195]_
90+
3. (`Coming soon <https://github.com/rmorshea/idom/issues/195>`_) Client side Javascript code
9191

9292
To run the full suite of tests you'll need to install:
9393

docs/source/javascript-modules.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,6 @@ you can use it with IDOM
2323
You can even define your own Javascript modules which use these third party Javascript
2424
packages.
2525

26-
.. note::
27-
28-
We're working to support non-standard packages too [GH166]_.
2926

3027
Installing React Components
3128
---------------------------

docs/source/known-issues.rst

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/source/life-cycle-hooks.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@ cases the :ref:`**Basic Hooks**` should be enough, however the remaining
88

99
.. note::
1010

11-
Not all of React's built-in hooks have been implemented. In the future they will be
12-
added, but if you have a particular need for a missing hook post an issue [GH203]_.
11+
Not all of React's built-in hooks have been implemented.
12+
`In the future <https://github.com/idom-team/idom/issues/203>`_ they will be
13+
added, but if you have a particular need for a missing hook post an issue.
1314

1415
.. contents::
1516
:local:
@@ -243,8 +244,9 @@ elements which check reference equality to prevent unnecessary renders. The of
243244

244245
The list of "dependencies" are not passed as arguments to the function. Ostensibly
245246
though, that is what they represent. Thus any variable referenced by the function
246-
must be listed as dependencies. We're working on a linter to help enforce this
247-
[GH202]_.
247+
must be listed as dependencies. We're
248+
`working on a linter <https://github.com/idom-team/idom/issues/202>`_ to help
249+
enforce this.
248250

249251

250252

@@ -277,8 +279,9 @@ after) and should not incur side effects.
277279

278280
The list of "dependencies" are not passed as arguments to the function ostensibly
279281
though, that is what they represent. Thus any variable referenced by the function
280-
must be listed as dependencies. We're working on a linter to help enforce this
281-
[GH202]_.
282+
must be listed as dependencies. We're
283+
`working on a linter <https://github.com/idom-team/idom/issues/202>`_
284+
to help enforce this.
282285

283286

284287
use_ref
@@ -302,11 +305,13 @@ hook alongside :ref:`use_effect` or in response to element event handlers.
302305
**Rules of Hooks**
303306
------------------
304307

305-
Under construction...
308+
Under construction... for now refer to
309+
`React's documentation <https://reactjs.org/docs/hooks-rules.html>`_ on this topic.
306310

307311
.. note::
308312

309-
We're working on a linter to help enforce the rules [GH202]_.
313+
We're `working on a linter <https://github.com/idom-team/idom/issues/202>`_ to help
314+
enforce the rules.
310315

311316

312317
.. links

0 commit comments

Comments
 (0)