docs: various minor grammatical changes (#6284)
* Update README.md * Update setting-up.md * Update plug-points.md * Update plugin-api.md * Update configuration.md * Update deep-linking.md * Update installation.md Co-authored-by: Tim Lai <timothy.lai@gmail.com>
This commit is contained in:
@@ -6,7 +6,7 @@ Often, it is beneficial to override the core internals to achieve custom behavio
|
||||
|
||||
### Note: Semantic Versioning
|
||||
|
||||
Swagger UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing.
|
||||
Swagger UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version change.
|
||||
|
||||
If your custom plugins wrap, extend, override, or consume any internal core APIs, we recommend specifying a specific minor version of Swagger UI to use in your application, because they will _not_ change between patch versions.
|
||||
|
||||
|
||||
@@ -4,7 +4,7 @@ A plugin is a function that returns an object - more specifically, the object ma
|
||||
|
||||
### Note: Semantic Versioning
|
||||
|
||||
Swagger UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version changing.
|
||||
Swagger UI's internal APIs are _not_ part of our public contract, which means that they can change without the major version change.
|
||||
|
||||
If your custom plugins wrap, extend, override, or consume any internal core APIs, we recommend specifying a specific minor version of Swagger UI to use in your application, because they will _not_ change between patch versions.
|
||||
|
||||
@@ -104,7 +104,7 @@ For more information about the concept of actions in Redux, see the [Redux Actio
|
||||
|
||||
#### Reducers
|
||||
|
||||
Reducers take a state (which is an [Immutable.js map](https://facebook.github.io/immutable-js/docs/#/Map)) and an action, and return a new state.
|
||||
Reducers take a state (which is an [Immutable.js map](https://facebook.github.io/immutable-js/docs/#/Map)) and an action, then returns a new state.
|
||||
|
||||
Reducers must be provided to the system under the name of the action type that they handle, in this case, `EXAMPLE_SET_FAV_COLOR`.
|
||||
|
||||
@@ -130,7 +130,7 @@ const MyReducerPlugin = function(system) {
|
||||
|
||||
Selectors reach into their namespace's state to retrieve or derive data from the state.
|
||||
|
||||
They're an easy way to keep logic in one place, and is preferred over passing state data directly into components.
|
||||
They're an easy way to keep logic in one place, and are preferred over passing state data directly into components.
|
||||
|
||||
|
||||
```javascript
|
||||
|
||||
@@ -7,7 +7,7 @@ Swagger UI includes a development server that provides hot module reloading and
|
||||
- git, any version
|
||||
- NPM 6.x
|
||||
|
||||
Generally, we recommend following guidelines from [Node.js Releases](https://nodejs.org/en/about/releases/) to only use Active LTS or Maintenance LTS releases.
|
||||
Generally, we recommend the following guidelines from [Node.js Releases](https://nodejs.org/en/about/releases/) to only use Active LTS or Maintenance LTS releases.
|
||||
|
||||
Current Node.js Active LTS:
|
||||
- Node.js 12.x
|
||||
|
||||
@@ -9,7 +9,7 @@ Swagger UI allows you to deeply link into tags and operations within a spec. Whe
|
||||
When you expand a tag or operation, Swagger UI will automatically update its URL fragment with a deep link to the item.
|
||||
Conversely, when you collapse a tag or operation, Swagger UI will clear the URL fragment.
|
||||
|
||||
You can also right-click a tag name or operation path in order to copy a link to that tag or operation.
|
||||
You can also right-click a tag name or operation path to copy a link to that tag or operation.
|
||||
|
||||
#### Fragment format
|
||||
|
||||
@@ -19,7 +19,7 @@ The fragment is formatted in one of two ways:
|
||||
- `#/{tagName}/{operationId}`, to trigger the focus of a specific operation within a tag
|
||||
|
||||
`operationId` is the explicit operationId provided in the spec, if one exists.
|
||||
Otherwise, Swagger UI generates an implicit operationId by combining the operation's path and method, and escaping non-alphanumeric characters.
|
||||
Otherwise, Swagger UI generates an implicit operationId by combining the operation's path and method, while escaping non-alphanumeric characters.
|
||||
|
||||
## FAQ
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ We publish two modules to npm: **`swagger-ui`** and **`swagger-ui-dist`**.
|
||||
|
||||
```javascript
|
||||
import SwaggerUI from 'swagger-ui'
|
||||
// or use require, if you prefer
|
||||
// or use require if you prefer
|
||||
const SwaggerUI = require('swagger-ui')
|
||||
|
||||
SwaggerUI({
|
||||
@@ -25,7 +25,7 @@ In contrast, **`swagger-ui-dist`** is meant for server-side projects that need a
|
||||
_Note: we suggest using `swagger-ui` when your tooling makes it possible, as `swagger-ui-dist`
|
||||
will result in more code going across the wire._
|
||||
|
||||
The module's contents mirrors the `dist` folder you see in the Git repository. The most useful file is `swagger-ui-bundle.js`, which is a build of Swagger UI that includes all the code it needs to run in one file. The folder also has an `index.html` asset, to make it easy to serve Swagger UI like so:
|
||||
The module's contents mirror the `dist` folder you see in the Git repository. The most useful file is `swagger-ui-bundle.js`, which is a build of Swagger UI that includes all the code it needs to run in one file. The folder also has an `index.html` asset, to make it easy to serve Swagger UI like so:
|
||||
|
||||
```javascript
|
||||
const express = require('express')
|
||||
|
||||
Reference in New Issue
Block a user