Minor improvements (pyscript#556)

ic-768 · Kevin Goldsmith · mattkram · web-flow · commit dc84d7c1b5c6 · 2022-06-28T14:16:05.000-05:00
* checkpoint: added some text

* checkpoint: added setting up the environment, tips for writing good issues

* continuing to fill it out

* added more detailed description of the process of creating a change and some other cleanup.

* added a getting started section and cleaned up the grammar. This ready for the PR now

* forgot to add the new section to the TOC

* Minor fixes

Co-authored-by: Kevin Goldsmith &lt;kgoldsmith@anaconda.com&gt;
Co-authored-by: Matt Kramer &lt;mkramer@anaconda.com&gt;
diff --git a/docs/README.md b/docs/README.md
@@ -11,7 +11,7 @@ take a look at the general contributing guidelines for the PyScript project. You
 
 ## Documentation Principles
 
-The PyScript documentation is based on a documentation framework called [Diátaxis](https://diataxis.fr/). This framework helps to solve the problem of structure in technical documentation and identifies four modes of documentation - **tutorials, how-to guides, technical reference and explanation**. Each one of these modes answers to a different user need, fulfils a different purpose and requires a different approach to its creation.
+The PyScript documentation is based on a documentation framework called [Diátaxis](https://diataxis.fr/). This framework helps to solve the problem of structure in technical documentation and identifies four modes of documentation - **tutorials, how-to guides, technical reference and explanation**. Each one of these modes answers to a different user need, fulfills a different purpose and requires a different approach to its creation.
 
 The picture below gives a good visual representation of that separation of concerns:
 
@@ -24,4 +24,4 @@ So, please keep that in mind when contributing to the project documentation. For
 The `docs` directory in the pyscript repository contains a
 [Sphinx](https://www.sphinx-doc.org/) documentation project. Sphinx is a system
 that takes plaintext files containing documentation written in Markdown, along with
-and static files like templates and themes, to build the static end result.
+static files like templates and themes, to build the static end result.
diff --git a/pyscriptjs/src/components/base.ts b/pyscriptjs/src/components/base.ts
@@ -152,11 +152,8 @@ export class BaseEvalElement extends HTMLElement {
                 this.outputElement.style.display = 'block';
             }
 
-            if (is_async) {
-              await pyodide.runPythonAsync(`output_manager.revert()`);
-            } else {
-              await pyodide.runPython(`output_manager.revert()`);
-            }
+            is_async ? await pyodide.runPythonAsync(`output_manager.revert()`)
+                     : await pyodide.runPython(`output_manager.revert()`);
 
             // check if this REPL contains errors, delete them and remove error classes
             const errorElements = document.querySelectorAll(`div[id^='${this.errorElement.id}'][error]`);
@@ -189,11 +186,10 @@ export class BaseEvalElement extends HTMLElement {
     } // end evaluate
 
     async eval(source: string): Promise<void> {
-        let output;
         const pyodide = runtime;
 
         try {
-            output = await pyodide.runPythonAsync(source);
+            const output = await pyodide.runPythonAsync(source);
             if (output !== undefined) {
                 console.log(output);
             }
@@ -268,10 +264,9 @@ function createWidget(name: string, code: string, klass: string) {
         }
 
         async eval(source: string): Promise<void> {
-            let output;
             const pyodide = runtime;
             try {
-                output = await pyodide.runPythonAsync(source);
+                const output = await pyodide.runPythonAsync(source);
                 this.proxyClass = pyodide.globals.get(this.klass);
                 if (output !== undefined) {
                     console.log(output);
@@ -281,7 +276,6 @@ function createWidget(name: string, code: string, klass: string) {
             }
         }
     }
-    const xPyWidget = customElements.define(name, CustomWidget);
 }
 
 export class PyWidget extends HTMLElement {
@@ -361,16 +355,14 @@ export class PyWidget extends HTMLElement {
     }
 
     async getSourceFromFile(s: string): Promise<string> {
-        const pyodide = runtime;
         const response = await fetch(s);
         return await response.text();
     }
 
     async eval(source: string): Promise<void> {
-        let output;
         const pyodide = runtime;
         try {
-            output = await pyodide.runPythonAsync(source);
+            const output = await pyodide.runPythonAsync(source);
             if (output !== undefined) {
                 console.log(output);
             }

Original file line number	Diff line number	Diff line change
`@@ -152,11 +152,8 @@ export class BaseEvalElement extends HTMLElement {`
`152`	`152`	`this.outputElement.style.display = 'block';`
`153`	`153`	`}`
`154`	`154`
`155`		`- if (is_async) {`
`156`		- await pyodide.runPythonAsync(`output_manager.revert()`);
`157`		`- } else {`
`158`		- await pyodide.runPython(`output_manager.revert()`);
`159`		`- }`
	`155`	+ is_async ? await pyodide.runPythonAsync(`output_manager.revert()`)
	`156`	+ : await pyodide.runPython(`output_manager.revert()`);
`160`	`157`
`161`	`158`	`// check if this REPL contains errors, delete them and remove error classes`
`162`	`159`	const errorElements = document.querySelectorAll(`div[id^='${this.errorElement.id}'][error]`);
`@@ -189,11 +186,10 @@ export class BaseEvalElement extends HTMLElement {`
`189`	`186`	`} // end evaluate`
`190`	`187`
`191`	`188`	`async eval(source: string): Promise<void> {`
`192`		`- let output;`
`193`	`189`	`const pyodide = runtime;`
`194`	`190`
`195`	`191`	`try {`
`196`		`- output = await pyodide.runPythonAsync(source);`
	`192`	`+ const output = await pyodide.runPythonAsync(source);`
`197`	`193`	`if (output !== undefined) {`
`198`	`194`	`console.log(output);`
`199`	`195`	`}`
`@@ -268,10 +264,9 @@ function createWidget(name: string, code: string, klass: string) {`
`268`	`264`	`}`
`269`	`265`
`270`	`266`	`async eval(source: string): Promise<void> {`
`271`		`- let output;`
`272`	`267`	`const pyodide = runtime;`
`273`	`268`	`try {`
`274`		`- output = await pyodide.runPythonAsync(source);`
	`269`	`+ const output = await pyodide.runPythonAsync(source);`
`275`	`270`	`this.proxyClass = pyodide.globals.get(this.klass);`
`276`	`271`	`if (output !== undefined) {`
`277`	`272`	`console.log(output);`
`@@ -281,7 +276,6 @@ function createWidget(name: string, code: string, klass: string) {`
`281`	`276`	`}`
`282`	`277`	`}`
`283`	`278`	`}`
`284`		`- const xPyWidget = customElements.define(name, CustomWidget);`
`285`	`279`	`}`
`286`	`280`
`287`	`281`	`export class PyWidget extends HTMLElement {`
`@@ -361,16 +355,14 @@ export class PyWidget extends HTMLElement {`
`361`	`355`	`}`
`362`	`356`
`363`	`357`	`async getSourceFromFile(s: string): Promise<string> {`
`364`		`- const pyodide = runtime;`
`365`	`358`	`const response = await fetch(s);`
`366`	`359`	`return await response.text();`
`367`	`360`	`}`
`368`	`361`
`369`	`362`	`async eval(source: string): Promise<void> {`
`370`		`- let output;`
`371`	`363`	`const pyodide = runtime;`
`372`	`364`	`try {`
`373`		`- output = await pyodide.runPythonAsync(source);`
	`365`	`+ const output = await pyodide.runPythonAsync(source);`
`374`	`366`	`if (output !== undefined) {`
`375`	`367`	`console.log(output);`
`376`	`368`	`}`