Skip to content

Commit

Permalink
typos
Browse files Browse the repository at this point in the history
  • Loading branch information
rodber committed Jan 24, 2024
1 parent 1146a80 commit c0c03a4
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 15 deletions.
2 changes: 1 addition & 1 deletion developer/standard/quality.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Our standard requires that code delivered by Chevere **must be**:

The code is continuously analyzed by many systems and third-party tools. All our packages will showcase a signature like this on the main `README.md` file:

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=alert_status)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=security_rating)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=coverage)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=sqale_index)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![CodeFactor](https://www.codefactor.io/repository/github/chevere/chevere/badge)](https://www.codefactor.io/repository/github/chevere/chevere) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/b956754f8ff04aaa9ca24a6e4cc21661)](https://www.codacy.com/gh/chevere/chevere/dashboard)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=alert_status)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=security_rating)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=coverage)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=chevere_chevere&metric=sqale_index)](https://sonarcloud.io/dashboard?id=chevere_chevere) [![CodeFactor](https://www.codefactor.io/repository/github/chevere/chevere/badge)](https://www.codefactor.io/repository/github/chevere/chevere)

We use the following third-party CI services:

Expand Down
6 changes: 3 additions & 3 deletions packages/action.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ composer require chevere/action

## Quick start

Implement [ActionInterface](src/interfaces/ActionInterface.php) by using the [Action trait](#use-actiontrait) or by extending [Action abstract](#extend-action).
Implement ActionInterface by using the [Action trait](#use-actiontrait) or by extending [Action abstract](#extend-action).

## Creating actions

### Use ActionTrait

Create an action by using [ActionTrait](src/Traits/ActionTrait.php).
Create an action by using ActionTrait.

```php
use Chevere\Action\Interfaces\ActionInterface;
Expand All @@ -37,7 +37,7 @@ class MyAction implements ActionInterface

### Extend Action

Create an Action by extending [Action](src/Action.php).
Create an Action by extending Action.

```php
use Chevere\Action\Action;
Expand Down
2 changes: 1 addition & 1 deletion packages/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ $cache = new Cache($directory);

## With Put

The `withPut` method is used to cache PHP [storable variable](../library/variable-support.md#storablevariable).
The `withPut` method is used to cache PHP [storable variable](./var-support.md#storablevariable).

```php
use Chevere\Cache\Cache;
Expand Down
2 changes: 1 addition & 1 deletion packages/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ composer require chevere/http

## Controller

The Controller in Http is a special Controller meant to be used in the context of HTTP requests. It extends [Action](https://chevere.org/packages/action) by adding request [parameters](https://chevere.org/packages/parameter.md) (query string, body, files) and attributes for statuses and headers.
The Controller in Http is a special Controller meant to be used in the context of HTTP requests. It extends [Action](https://chevere.org/packages/action) by adding request [parameters](https://chevere.org/packages/parameter) (query string, body, files) and attributes for statuses and headers.

```php
use Chevere\Http\Controller;
Expand Down
2 changes: 1 addition & 1 deletion packages/router.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ composer require chevere/router
## Features

* Define path, name, view, middleware and HTTP method to controller binding using named arguments.
* HTTP method binding works with [Controller](../library/http-controller.md) objects.
* HTTP method binding works with [Controller](./http.md#controller) objects.
* Path variables inherits regex from parameter attributes at controller layer.
* Can be implicit (`{id}`) or explicit (`{id:[0-9]+}`).
* Detects conflicts for all endpoints.
Expand Down
8 changes: 4 additions & 4 deletions packages/schwager.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,9 +127,9 @@ Path endpoints are mapped by HTTP method name within the `endpoints` property.

### Schemas

The body schema `*_BODY_SCHEMA` describes the payload body. It supports [parameter](../library/parameter.md) schema of any type.
The body schema `*_BODY_SCHEMA` describes the payload body. It supports [parameter](./parameter.md) schema of any type.

The query schema `REQUEST_QUERY_SCHEMA` describes the request query string. It supports an array of [strings](../library/parameter.md#array-string).
The query schema `REQUEST_QUERY_SCHEMA` describes the request query string. It supports an array of [strings](./parameter.md#array-string).

### Request

Expand Down Expand Up @@ -182,7 +182,7 @@ $array = $spec->toArray();

## Filtering result

The `arrayFilter*` functions provided by the [Standard](../library/standard.md) component enable to modify and/or filter the generated API spec. This is useful to remove `null` values, empty strings and context-aware redundant information.
The `arrayFilter*` functions provided by the [Standard](./standard.md) component enable to modify and/or filter the generated API spec. This is useful to remove `null` values, empty strings and context-aware redundant information.

For example to recursive filter the array by value `$v` and key `$k`:

Expand Down Expand Up @@ -218,7 +218,7 @@ For cases `1,2,3` the removal is for empty values while for cases `4,5,6` is bec

## Export

Use the built-in [Filesystem](../library/filesystem.md#file) component to store the converted array with native [json_encode](https://www.php.net/manual/en/function.json-encode.php) as a JSON file.
Use the built-in [Filesystem](./filesystem.md#file) component to store the converted array with native [json_encode](https://www.php.net/manual/en/function.json-encode.php) as a JSON file.

```php
use function Chevere\Filesystem\fileForPath;
Expand Down
2 changes: 0 additions & 2 deletions packages/standard.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,6 @@ Improvements and alternatives to PHP's standard function library.

Standard is available through [Packagist](https://packagist.org/packages/chevere/standard) and the repository source is at [chevere/standard](https://github.com/chevere/standard).

The Standard component .

## arrayFilterBoth

This function enables to recursive filter an array by key and value. It improves on [array_filter](https://www.php.net/manual/en/function.array-filter.php).
Expand Down
4 changes: 2 additions & 2 deletions packages/var-dump.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ vdd($myVar); // var dump and die
* Same as copy HTML text
* HTML document
* Colorful representation
* Portable (also used on [xrDebug](xr.md))
* Portable (also used on [xrDebug](./xrdebug.md))

## Helpers

Expand Down Expand Up @@ -138,7 +138,7 @@ $varDump = $varDump->withShift(1); // removes the first trace

### Process

The method `process` is used to trigger the var dumping process. It requires to pass a [writer](../library/writer.md) where the dump information will be written.
The method `process` is used to trigger the var dumping process. It requires to pass a [writer](./writer.md) where the dump information will be written.

```php
use Chevere\Writer\StreamWriter;
Expand Down

0 comments on commit c0c03a4

Please sign in to comment.