8000 Fixed typos reported so far. · pyscript/docs@39f1c5c · GitHub
[go: up one dir, main page]

Skip to content

Commit 39f1c5c

Browse files
committed
Fixed typos reported so far.
1 parent bd3041c commit 39f1c5c

File tree

3 files changed

+8
-18
lines changed

3 files changed

+8
-18
lines changed

docs/faq.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -517,7 +517,7 @@ poor introspection capabilities:
517517
* Making use of the capitalized-name-for-classes convention is brittle because
518518
when JavaScript code is minified the class name can sometimes change.
519519
* This leaves our convention of `Class.new()` to explicitly signal the intent
520-
to instantiate a JavaScript class. While not idea it is clear and
520+
to instantiate a JavaScript class. While not ideal it is clear and
521521
unambiguous.
522522

523523
### PyScript events
@@ -838,11 +838,6 @@ def download_file(path, mime_type):
838838
# should keep the memory clear for the session
839839
```
840840

841-
!!! warning
842-
843-
This currently only works with Pyodide due to a bug instantiating
844-
`window.File` in MicroPython.
845-
846841
### create_proxy
847842

848843
The `create_proxy` function is described in great detail
@@ -1148,15 +1143,9 @@ you're using Pyodide or MicroPython as your interpreter.
11481143
**When using `pyscript.to_js`, the result is detached from the original
11491144
Python dictionary.**
11501145

1151-
Any change to the JavaScript object **will not be reflected in the original
1152-
Python object**. For the vast majority of use cases, this is a desirable
1153-
trade-off. But it's important to note this detachment.
1154-
1155-
The ability for a `Map` to remain attached to the related Python `dict` is
1156-
perhaps an important reason Pyodide chose this implementation detail.
1157-
Therefore, if you have JavaScript code that requires changes of state to be
1158-
reflected in the Python world you should use the underlying `pyodide.ffi.to_js`
1159-
API.
1146+
Any change to the JavaScript object **will not be reflected in the original
1147+
Python object**. For the vast majority of use cases, this is a desirable
1148+
trade-off. But it's important to note this detachment.
11601149

11611150
If you're simply passing data around, `pyscript.ffi.to_js` will fulfil your
11621151
requirements in a simple and idiomatic manner.

docs/index.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,14 @@
2626
<a href="beginning-pyscript">beginning PyScript guide</a>
2727
and then using
2828
<a href="https://pyscript.com/" target="_blank">pyscript.com</a>
29-
to create your first apps.</dd>
29+
to create your first apps. Having problems? Check out our
30+
<a href="faq">frequently asked questions</a>.</dd>
3031
<dt><strong>I'm already technical...</strong></dt>
3132
<dd>The beginner docs will set you up with a simple coding environment. For
3233
more in-depth technical coverage of PyScript, consult the
3334
<a href="user-guide">user guide</a>. The
3435
<a href="examples">example applications</a> demonstrate many of the features
35-
of PyScript.</dd>
36+
of PyScript. The <a href="faq">FAQ</a> contains lots of technical detail.</dd>
3637
<dt><strong>I want to contribute...</strong></dt>
3738
<dd>
3839
<p>Welcome, friend!

docs/user-guide/workers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ attribute flag:
5555
```
5656

5757
Alternatively, to launch a worker from within Python running on the main thread
58-
use the [pyscript.PyWorker](../builtins/#pyscriptpyworker) class and must
58+
use the [pyscript.PyWorker](../builtins/#pyscriptpyworker) class and you must
5959
reference both the target Python script and interpreter type:
6060

6161
```python title="Launch a worker from within Python"

0 commit comments

Comments
 (0)
0