Skip to content

Commit

Permalink
Minor doc edits
Browse files Browse the repository at this point in the history
  • Loading branch information
phil-davis committed Aug 26, 2018
1 parent f3e0d92 commit d202d53
Show file tree
Hide file tree
Showing 10 changed files with 14 additions and 14 deletions.
6 changes: 3 additions & 3 deletions deprecations.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ The `Handler` type and associated calls will be removed in version 2.0.

### Upgrade path

You should either create your own implementation for handling OOP usage,
You should create your own implementation for handling OOP usage,
but it's recommended to move away from using an OOP-style wrapper entirely.

The reason for this is that it's too easy for implementation details (for
your application this is Flysystem) to leak into the application. The most
important part for Flysystem is that it improved portability and creates a
important part for Flysystem is that it improves portability and creates a
solid boundary between your application core and the infrastructure you use.
The OOP-style handling breaks this principle, therefor I want to stop
The OOP-style handling breaks this principle, therefore I want to stop
promoting it.
2 changes: 1 addition & 1 deletion docs/advanced/caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Caching
---

File system I/O is slow, so Flysystem uses cached file system meta-data to boost performance. When your application needs to scale you can also choose to use a (shared) persistent caching solution for this.
Or enable a per request caching (recommended).
Or enable per request caching (recommended).

## Installing the adapter cache decorator

Expand Down
4 changes: 2 additions & 2 deletions docs/advanced/mount-manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ foreach ($contents as $entry) {
### Copy

The copy method provided by the Mount Manager takes the origin of the file into account.
When it detects the source and destination are located on a different file systems it'll
When it detects the source and destination are located on different file systems it'll
use a streamed upload instead, transparently.

```php
Expand All @@ -70,7 +70,7 @@ $mountManager->copy('local://some/file.ext', 'backup://storage/location.ext');
### Move

The `move` call is the multi-file system counterpart to `rename`. Where rename must be used on
the same file system, the `move` call provides the same conceptual behavior, but then on two
the same file system, the `move` call provides the same conceptual behavior, but on two
different file systems.

```php
Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Performance
---

Flysystem aims to be as reliable as possible. In some cases this means doing extra
checks to make sure the outcome will be as expected. For some adapter this means Flysystem
checks to make sure the outcome will be as expected. For some adapters this means Flysystem
will make extra calls to assert whether or not a file exists. This improves the reliability
but also impacts performance. You can opt out of this behaviour.

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/provided-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ foreach ($listing as $object) {
}
```

## Get file into with explicit metadata.
## Get file info with explicit metadata.

This requires the `League\Flysystem\Plugin\GetWithMetadata` plugin.

Expand Down
2 changes: 1 addition & 1 deletion docs/advanced/upgrade-to-1.0.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ $filesystem = new Filesystem($decoratedAdapter);

## Helper Methods

In order to clean up the Filsystem class, some helper functions have been moved to plugins.
In order to clean up the Filesystem class, some helper functions have been moved to plugins.

* ListWith
* ListPaths
Expand Down
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ foreach ($listing as $object) {
}
~~~

__Get file into with explicit metadata__
__Get file info with explicit metadata__

~~~ php
$info = $filesystem->getWithMetadata('path/to/file.txt', ['timestamp', 'mimetype']);
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ timestamp | modified time | `integer`
In order to make the most out of every (expensive) filesystem call adapters
return as much information as they can when/if available. This makes it possible
for caching mechanisms to store this information so subsequent calls can be
returned from cache without the need for additional filesystems calls.
returned from cache without the need for additional filesystem calls.
4 changes: 2 additions & 2 deletions docs/guides/deterministic-programming.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ problematic.

## Filesystems are slow.

In general, filesystem interaction is slow. Every operation operation that
In general, filesystem interaction is slow. Every operation that
hits the disc in one way or another is slow. While some operations absolutely
require filesystem interaction, there's a number of cases where filesystem
operations can be prevented in order to eliminate the associated penalties.
Expand Down Expand Up @@ -66,6 +66,6 @@ you can store all the paths in a persistent database. While this is
not a conventional thing to do it certainly has a lot of benefits.

File listings are just a select statement: `SELECT * FROM files WHERE path LIKE '/prefix/%'`.
Listings can easily be sorted. File existence checks are in expensive.
Listings can easily be sorted. File existence checks are inexpensive.
File migrations become really easy, even when your path generation
strategy changes. Metadata can be stored alongside your path.
2 changes: 1 addition & 1 deletion docs/usage/filesystem-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ param | description | type

## Get Timestamps

This function the last updated timestamp.
This function returns the last updated timestamp.

```php
$response = $filesystem->getTimestamp($path);
Expand Down

0 comments on commit d202d53

Please sign in to comment.