Fix doctest spell check (#1570)

This commit is contained in:
Justin Starry 2020-09-20 12:29:56 +08:00 committed by GitHub
parent 11ba35cf9d
commit 80b31b9396
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
16 changed files with 25 additions and 86 deletions

View File

@ -1,16 +0,0 @@
name: Documentation tests
on:
push:
paths:
- "docs/**/*"
pull_request:
paths:
- "docs/**/*"
jobs:
check-spelling:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Check spelling
run: bash ci/spellcheck.sh list

View File

@ -102,6 +102,9 @@ jobs:
restore-keys: | restore-keys: |
cargo-${{ runner.os }}- cargo-${{ runner.os }}-
- name: Check spelling
run: bash ci/spellcheck.sh list
- name: Run doctest - name: Run doctest
uses: actions-rs/cargo@v1 uses: actions-rs/cargo@v1
with: with:

View File

@ -1,62 +1,20 @@
personal_ws-1.1 en 72 utf-8 personal_ws-1.1 en 88 utf-8
APIs
AddOne
Angular's Angular's
AppRoute
Barebones
Borrow
BorrowMut
ComponentLink
Config Config
ConsoleService
Deref Deref
DerefMut
DevTools
ExampleProps
Github Github
HashMap Json
IHtmlElement
INIT
InputElement
Javascript
Lifecycle Lifecycle
MaterialUi
MyComponent
NeqAssign
NodeRef
Optimisations
Optimizations
PartialEq
PureComponents
README
React
React's React's
RouteAgent
RouteService
Routeservice
SetInputEnabled
ShouldRender
SomePureComponent
TODO
Todo Todo
TryFrom
Vec
VecDeque VecDeque
ViewPost
ViewPosts
Vuetify
WebAssembly
Webpack Webpack
WeeAlloc
Workspaces
Yewtil
alloc alloc
allocator allocator
asmjs asmjs
backends backends
behavior barebones
binaryen binaryen
bincode
bindgen bindgen
bool bool
boolean boolean
@ -68,11 +26,8 @@ composable
declaratively declaratively
doctype doctype
emscripten emscripten
endcode
endhint
enum enum
enums enums
favor
href href
html html
impl impl
@ -84,35 +39,32 @@ lang
libs libs
lifecycle lifecycle
memoized memoized
minimising metaprogramming
minimize minimize
miniserve miniserve
mkdir mkdir
natively natively
onclick onclick
optimisations
optimization
optimizations
optimize
optimizes
proc proc
recognise
rlib rlib
roadmap roadmap
rollup rollup
rustc
rustfmt
rustwasm rustwasm
serializing
stacktraces stacktraces
standardization
stdweb stdweb
struct struct
structs structs
tbody tbody
thead thead
toml toml
unboxed
usize usize
vdom vdom
vtag
wasm wasm
webpack webpack
workspaces workspaces
vuetify
yewtil yewtil

View File

@ -74,7 +74,7 @@ elif [[ "$mode" == "list" ]]; then
fi fi
for fname in "${markdown_sources[@]}"; do for fname in "${markdown_sources[@]}"; do
command=$(aspell --ignore 3 --personal="$dict_path" "$mode" < "$fname") command=$(aspell --ignore 3 --camel-case --personal="$dict_path" "$mode" < "$fname")
if [[ -n "$command" ]]; then if [[ -n "$command" ]]; then
for error in $command; do for error in $command; do
# FIXME: find more correct way to get line number # FIXME: find more correct way to get line number

View File

@ -5,7 +5,7 @@ description: The procedural macro for generating HTML and SVG
--- ---
The `html!` macro allows you to write HTML and SVG code declaratively. It is similar to JSX The `html!` macro allows you to write HTML and SVG code declaratively. It is similar to JSX
\(an extension to Javascript which allows you to write HTML-like code inside of Javascript\). \(an extension to JavaScript which allows you to write HTML-like code inside of JavaScript\).
**Important notes** **Important notes**

View File

@ -23,7 +23,7 @@ cargo build --target wasm32-unknown-unknown
Then, run wasm-bindgen's CLI. This command will produce a set of files in the `--out-dir` directory Then, run wasm-bindgen's CLI. This command will produce a set of files in the `--out-dir` directory
containing both your app's compiled WebAssembly and a JavaScript wrapper which will load containing both your app's compiled WebAssembly and a JavaScript wrapper which will load
the Wasm binary and run it. This is necessary because browsers currently can't load WebAssembly files the Wasm binary and run it. This is necessary because browsers currently can't load WebAssembly files
directly instead requiring them to be loaded via Javascript scripts. In the [build a sample app](../build-a-sample-app.md) example we want the files to be generated in the `static` folder (to do this you'll need directly instead requiring them to be loaded via JavaScript scripts. In the [build a sample app](../build-a-sample-app.md) example we want the files to be generated in the `static` folder (to do this you'll need
to pass `--out-dir static` as a flag to `wasm-bindgen`) and be called `wasm.js` and `wasm_bg.wasm` to pass `--out-dir static` as a flag to `wasm-bindgen`) and be called `wasm.js` and `wasm_bg.wasm`
(you can do this by passing `--out-name wasm` as a flag to `wasm-bindgen`). (you can do this by passing `--out-name wasm` as a flag to `wasm-bindgen`).

View File

@ -15,7 +15,7 @@ adopting the most popular one.
The community are currently developing a number of projects to make it easy to add styles to The community are currently developing a number of projects to make it easy to add styles to
projects. A few are given below: projects. A few are given below:
* [yew_styles](https://github.com/spielrs/yew_styles) - A styling framework for Yew without any Javascript dependencies. * [yew_styles](https://github.com/spielrs/yew_styles) - A styling framework for Yew without any JavaScript dependencies.
* [yew-mdc](https://github.com/Follpvosten/yew-mdc) - Material Design Components. * [yew-mdc](https://github.com/Follpvosten/yew-mdc) - Material Design Components.
* [muicss-yew](https://github.com/AlephAlpha/muicss-yew) - MUI CSS Components. * [muicss-yew](https://github.com/AlephAlpha/muicss-yew) - MUI CSS Components.
* [Yewtify](https://github.com/yewstack/yewtify) Implements the features provided by the Vuetify framework in Yew. * [Yewtify](https://github.com/yewstack/yewtify) Implements the features provided by the Vuetify framework in Yew.

View File

@ -8,7 +8,7 @@ description: Libraries that can help with Yew development
Yewtil is a collection of common utilities that help you build applications using Yew. It includes: Yewtil is a collection of common utilities that help you build applications using Yew. It includes:
* NeqAssign - This is described in more detail in the section on * NeqAssign - This is described in more detail in the section on
[optimisations and best practices](../advanced-topics/optimizations.md) and ensures that identical [optimizations and best practices](../advanced-topics/optimizations.md) and ensures that identical
sets of props don't cause a component to re-render. sets of props don't cause a component to re-render.
* PureComponents - Components that don't update any of their state. Using NeqAssign under the hood, they act as memoized * PureComponents - Components that don't update any of their state. Using NeqAssign under the hood, they act as memoized

View File

@ -1,4 +1,4 @@
# (Asynchronous) callback from Javascript # (Asynchronous) callback from JavaScript
The purpose of this example is to demonstrate a simple case of asynchronously The purpose of this example is to demonstrate a simple case of asynchronously
sending a message back into the component update loop. sending a message back into the component update loop.

View File

@ -8,7 +8,7 @@ title: Introduction
- **基于组件的框架**,可以轻松的创建交互式 UI。拥有 [React](https://reactjs.org/) 或 [Elm](https://elm-lang.org/) 等框架经验的开发人员在使用 Yew 时会感到得心应手。 - **基于组件的框架**,可以轻松的创建交互式 UI。拥有 [React](https://reactjs.org/) 或 [Elm](https://elm-lang.org/) 等框架经验的开发人员在使用 Yew 时会感到得心应手。
- **高性能** ,前端开发者可以轻易的将工作分流至后端来减少 DOM API 的调用,从而达到异常出色的性能。 - **高性能** ,前端开发者可以轻易的将工作分流至后端来减少 DOM API 的调用,从而达到异常出色的性能。
- **支持与 Javascript 交互** ,允许开发者使用 NPM 包,并与现有的 Javascript 应用程序结合。 - **支持与 JavaScript 交互** ,允许开发者使用 NPM 包,并与现有的 JavaScript 应用程序结合。
### 加入我们 😊 ### 加入我们 😊

View File

@ -8,7 +8,7 @@ title: Introduction
- **基于组件的框架**,可以轻松的创建交互式 UI。拥有 [React](https://reactjs.org/) 或 [Elm](https://elm-lang.org/) 等框架经验的开发人员在使用 Yew 时会感到得心应手。 - **基于组件的框架**,可以轻松的创建交互式 UI。拥有 [React](https://reactjs.org/) 或 [Elm](https://elm-lang.org/) 等框架经验的开发人员在使用 Yew 时会感到得心应手。
- **高性能** ,前端开发者可以轻易的将工作分流至后端来减少 DOM API 的调用,从而达到异常出色的性能。 - **高性能** ,前端开发者可以轻易的将工作分流至后端来减少 DOM API 的调用,从而达到异常出色的性能。
- **支持与 Javascript 交互** ,允许开发者使用 NPM 包,并与现有的 Javascript 应用程序结合。 - **支持与 JavaScript 交互** ,允许开发者使用 NPM 包,并与现有的 JavaScript 应用程序结合。
### 加入我们 😊 ### 加入我们 😊

View File

@ -7,7 +7,7 @@ original_id: html
--- ---
The `html!` macro allows you to write HTML and SVG code declaratively. It is similar to JSX The `html!` macro allows you to write HTML and SVG code declaratively. It is similar to JSX
\(an extension to Javascript which allows you to write HTML-like code inside of Javascript\). \(an extension to JavaScript which allows you to write HTML-like code inside of JavaScript\).
**Important notes** **Important notes**

View File

@ -25,7 +25,7 @@ cargo build --target wasm32-unknown-unknown
Then, run wasm-bindgen's CLI. This command will produce a set of files in the `--out-dir` directory Then, run wasm-bindgen's CLI. This command will produce a set of files in the `--out-dir` directory
containing both your app's compiled WebAssembly and a JavaScript wrapper which will load containing both your app's compiled WebAssembly and a JavaScript wrapper which will load
the Wasm binary and run it. This is necessary because browsers currently can't load WebAssembly files the Wasm binary and run it. This is necessary because browsers currently can't load WebAssembly files
directly instead requiring them to be loaded via Javascript scripts. In the [build a sample app](../build-a-sample-app.md) example we want the files to be generated in the `static` folder (to do this you'll need directly instead requiring them to be loaded via JavaScript scripts. In the [build a sample app](../build-a-sample-app.md) example we want the files to be generated in the `static` folder (to do this you'll need
to pass `--out-dir static` as a flag to `wasm-bindgen`) and be called `wasm.js` and `wasm_bg.wasm` to pass `--out-dir static` as a flag to `wasm-bindgen`) and be called `wasm.js` and `wasm_bg.wasm`
(you can do this by passing `--out-name wasm` as a flag to `wasm-bindgen`). (you can do this by passing `--out-name wasm` as a flag to `wasm-bindgen`).

View File

@ -12,7 +12,7 @@ A proposal for integrated CSS support can be found here: [https://github.com/yew
Currently our community members are developing these style frameworks: Currently our community members are developing these style frameworks:
* [yew_styles](https://github.com/spielrs/yew_styles) - A styling framework for Yew without any Javascript dependencies. * [yew_styles](https://github.com/spielrs/yew_styles) - A styling framework for Yew without any JavaScript dependencies.
* [yew-mdc](https://github.com/Follpvosten/yew-mdc) - Material Design Components. * [yew-mdc](https://github.com/Follpvosten/yew-mdc) - Material Design Components.
* [muicss-yew](https://github.com/AlephAlpha/muicss-yew) - MUI CSS Components. * [muicss-yew](https://github.com/AlephAlpha/muicss-yew) - MUI CSS Components.
* [Yewtify](https://github.com/yewstack/yewtify) Implements the features provided by the Vuetify framework in Yew. * [Yewtify](https://github.com/yewstack/yewtify) Implements the features provided by the Vuetify framework in Yew.

View File

@ -1,4 +1,4 @@
(Asynchronous) callback from Javascript (Asynchronous) callback from JavaScript
======================================= =======================================
The purpose of this example is to demonstrate a simple case of asynchronously The purpose of this example is to demonstrate a simple case of asynchronously

View File

@ -383,7 +383,7 @@ where
let body = body.into().ok(); let body = body.into().ok();
// Prepare the response callback. // Prepare the response callback.
// Notice that the callback signature must match the call from the javascript // Notice that the callback signature must match the call from the JavaScript
// side. There is no static check at this point. // side. There is no static check at this point.
let callback = move |success: bool, status: u16, headers: HashMap<String, String>, data: X| { let callback = move |success: bool, status: u16, headers: HashMap<String, String>, data: X| {
let mut response_builder = Response::builder(); let mut response_builder = Response::builder();