diff --git a/common-docs/blocks.md b/common-docs/blocks.md index a549e06274aa..762eb563375d 100644 --- a/common-docs/blocks.md +++ b/common-docs/blocks.md @@ -3,7 +3,8 @@ ### @description Language constructs for the Block editor. ## #blocksbase -Blocks snap into each other to define the program that your @boardname@ will run. + +Blocks snap into each other to define the program that will run. Blocks can be event (buttons, shake, ...) or need to be snapped into an event to run. The [on-start](/blocks/on-start) event runs first. diff --git a/common-docs/javascript/call.md b/common-docs/javascript/call.md index cab11669b17d..9c9173d387d0 100644 --- a/common-docs/javascript/call.md +++ b/common-docs/javascript/call.md @@ -1,8 +1,8 @@ # Call a function -The simplest way to get started in JavaScript with your @boardname@ is to -call one of the @boardname@'s built-in JavaScript functions. Just like how Blocks -are organized into categories/drawers, the @boardname@ functions are organized by +The simplest way to get started in JavaScript is to +call one of the built-in JavaScript functions. Just like how Blocks +are organized into categories/drawers, the functions are organized by namespaces, with names corresponding to the drawer names. ```typescript-ignore @@ -11,6 +11,8 @@ Math.abs(-1) ### ~ hint +#### Functions in a namespace + If you want to see all functions available in the `Math` namespace, simply type `Math` followed by `.` and a list of all the functions will appear. diff --git a/common-docs/javascript/functions.md b/common-docs/javascript/functions.md index 7ade2e99c6f1..4403eed17310 100644 --- a/common-docs/javascript/functions.md +++ b/common-docs/javascript/functions.md @@ -14,7 +14,9 @@ let sum = add(1, 2); ### ~ hint -For the @boardname@, you must specify a [type](/javascript/types) for each function parameter. +#### Parameter types + +You must specify a [type](/javascript/types) for each function parameter. ### ~ diff --git a/common-docs/javascript/operators.md b/common-docs/javascript/operators.md index ac61b826f487..8f5680b6d0a9 100644 --- a/common-docs/javascript/operators.md +++ b/common-docs/javascript/operators.md @@ -1,6 +1,6 @@ # Operators -The following JavaScript operators are supported for the @boardname@. +The following JavaScript operators are supported: ## Assignment, arithmetic and bitwise diff --git a/common-docs/javascript/sequence.md b/common-docs/javascript/sequence.md index ef6fe10c5ead..687c5ebffa3f 100644 --- a/common-docs/javascript/sequence.md +++ b/common-docs/javascript/sequence.md @@ -36,6 +36,8 @@ doSomething(); // THIS LINE WILL NEVER EXECUTE! ### ~hint +#### No 'empty' statements + To avoid this problem, we don't allow a program to contain an empty statement, such as shown above. If you really want an empty statement, you need to use curly braces to delimit an empty statement block: ```typescript-ignore diff --git a/common-docs/javascript/statements.md b/common-docs/javascript/statements.md index 2d2c836931ec..384e5d2e026b 100644 --- a/common-docs/javascript/statements.md +++ b/common-docs/javascript/statements.md @@ -1,6 +1,6 @@ # Statements -The following JavaScript statements are supported for the @boardname@: +The following JavaScript statements are supported: ## Variable declarations * [`const` statement](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/const) diff --git a/common-docs/python/call.md b/common-docs/python/call.md index 2556d77855e7..7933d1d2d5c7 100644 --- a/common-docs/python/call.md +++ b/common-docs/python/call.md @@ -1,9 +1,9 @@ # Call a function -The simplest way to get started in Python with your @boardname@ is to -call one of the @boardname@'s built-in Python functions. Just like how Blocks -are organized into categories/drawers, the @boardname@ functions are organized by -namespaces, with names corresponding to the drawer names. +The simplest way to get started in Python is to +call one of the built-in Python functions. Just like how Blocks +are organized into categories/drawers, functions are organized by +namespaces too, with names corresponding to the drawer names. ```python-ignore Math.abs(-1) @@ -11,6 +11,8 @@ Math.abs(-1) ### ~ hint +#### Functions in a namespace + If you want to see all functions available in the `Math` namespace, simply type `Math` followed by `.` and a list of all the functions will appear. diff --git a/common-docs/python/functions.md b/common-docs/python/functions.md index e8bc30bf9e3b..d51a008a544f 100644 --- a/common-docs/python/functions.md +++ b/common-docs/python/functions.md @@ -96,7 +96,7 @@ The default value of `lastName` disappears in the type, only leaving behind the Handler functions are functions that take some action when an event or change of state occurs. Usually, some other code saves, or registers, the handler function in a variable in order to call it at a later time. When an event happens, like a new input value or an elapsed timer, the handler is called to run a response action. -As an example, the `Thermal` class will check for changes in temperature and run a registered handler when the temperature drops to a set thershold: +As an example, the `Thermal` class will check for changes in temperature and run a registered handler when the temperature drops to a set threshold: ```python-ignore # the handler function when it's cold... @@ -122,9 +122,9 @@ thermal.whenCold(whenCold) thermal.checkCold() ``` -## Lamda Functions +## Lambda Functions -Lamda functions serve as a kind of shortcut to return a result of an expression. A lamda is often saved to a variable and then used like a function to return the expression result: +Lambda functions serve as a kind of shortcut to return a result of an expression. A lambda is often saved to a variable and then used like a function to return the expression result: ```python-ignore def square(x): diff --git a/common-docs/python/operators.md b/common-docs/python/operators.md index 7f5e8b7dc27e..7887d6b29d8f 100644 --- a/common-docs/python/operators.md +++ b/common-docs/python/operators.md @@ -1,6 +1,6 @@ # Operators -The following Python operators are supported for the @boardname@. +The following Python operators are supported: ## Assignment, arithmetic and bitwise diff --git a/common-docs/python/statements.md b/common-docs/python/statements.md index fa5dc89fd865..382fdd6680f5 100644 --- a/common-docs/python/statements.md +++ b/common-docs/python/statements.md @@ -1,6 +1,6 @@ # Statements -The following Python statements are supported for the @boardname@: +The following Python statements are supported: ## Variable declarations diff --git a/common-docs/types.md b/common-docs/types.md index 050e0bfe71ae..e2e897c869bb 100644 --- a/common-docs/types.md +++ b/common-docs/types.md @@ -1,7 +1,7 @@ # Types A *type* refers to a class of data and the operations permitted on that class of data. -The following built-in types are supported for the @boardname@: +The following built-in types are supported: ## Basic (primitive) types #primitives