beenull/Pico
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix typos

Browse source
This commit is contained in:
Daniel Rudolf 2015-11-04 19:50:44 +01:00
parent 2a43b21bae
commit af8de56512
6 changed files with 20 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
CHANGELOG.md
View file

@ -37,8 +37,8 @@ Released: 2015-11-06
* [Changed] Complete code refactoring
* [Changed] Source code now follows PSR code styling
* [Changed] Replacing constants (e.g. `ROOT_DIR`) with constructor parameters
* [Changed] Paths (e.g. `content_dir`) are now relative to Picos root dir
* [Changed] Adding `Pico::run()` method that performs Picos processing and
* [Changed] Paths (e.g. `content_dir`) are now relative to Pico's root dir
* [Changed] Adding `Pico::run()` method that performs Pico's processing and
returns the rendered contents
* [Changed] Renaming all plugin events; adding some new events
* [Changed] `Pico_Plugin` is now the fully documented `DummyPlugin`
@ -70,7 +70,7 @@ Released: 2015-11-06
* [Fixed] A vast number of small bugs...
* [Removed] Removing the default Twig cache dir
* [Removed] Removing various empty `index.html` files
* [Removed] Moving Picos excerpt feature to `PicoExcerpt` plugin
* [Removed] Moving Pico's excerpt feature to `PicoExcerpt` plugin
```
### Version 0.9

10
CONTRIBUTING.md
View file

@ -10,14 +10,14 @@ Having said that: we really appreciate it when you apply the guidelines in part
Issues
------
If you want to report an *issue* with Picos core, please create a new [Issue](https://github.com/picocms/Pico/issues) on GitHub. Concerning problems with plugins or themes, please refer to the website of the developer of this plugin or theme.
If you want to report an *issue* with Pico's core, please create a new [Issue](https://github.com/picocms/Pico/issues) on GitHub. Concerning problems with plugins or themes, please refer to the website of the developer of this plugin or theme.
Before creating a [new Issue on GitHub](https://github.com/picocms/Pico/issues/new), please make sure the problem wasn't reported yet using [GitHubs search engine](https://github.com/picocms/Pico/search?type=Issues). Please describe your issue as clear as possible and always include steps to reproduce the problem.
Contributing code
-----------------
Once you decide you want to contribute to *Picos core* (which we really appreciate!) you can fork the project from https://github.com/picocms/Pico. If you're interested in developing a *plugin* or *theme* for Pico, please refer to the [development section](http://picocms.org/plugin-dev.html) of our website.
Once you decide you want to contribute to *Pico's core* (which we really appreciate!) you can fork the project from https://github.com/picocms/Pico. If you're interested in developing a *plugin* or *theme* for Pico, please refer to the [development section](http://picocms.org/plugin-dev.html) of our website.
### Prevent `merge-hell`
@ -45,9 +45,9 @@ With this command you can specify a file or folder to limit which files it will
### Keep documentation in sync
Pico accepts the problems of having redundant documentation on different places (concretely Picos inline user docs, the `README.md` and the website) for the sake of a better user experience. When updating the docs, please make sure the keep them in sync.
Pico accepts the problems of having redundant documentation on different places (concretely Pico's inline user docs, the `README.md` and the website) for the sake of a better user experience. When updating the docs, please make sure the keep them in sync.
If you update the [`README.md`](https://github.com/picocms/Pico/blob/master/README.md) or [`content-sample/index.md`](https://github.com/picocms/Pico/blob/master/content-sample/index.md), please make sure to update the corresponding files in the [`_docs`](https://github.com/picocms/Pico/tree/gh-pages/_docs/) folder of the `gh-pages` branch (i.e. [Picos website](http://picocms.org/docs.html)) and vice verca. Unfortunately this involves three (!) different markdown parsers. If you're experiencing problems, use Picos [`erusev/parsedown-extra`](https://github.com/erusev/parsedown-extra) as a reference. You can try to make the contents compatible to [Redcarpet](https://github.com/vmg/redcarpet) by yourself, otherwise please address the issues in your pull request message and we'll take care of it.
If you update the [`README.md`](https://github.com/picocms/Pico/blob/master/README.md) or [`content-sample/index.md`](https://github.com/picocms/Pico/blob/master/content-sample/index.md), please make sure to update the corresponding files in the [`_docs`](https://github.com/picocms/Pico/tree/gh-pages/_docs/) folder of the `gh-pages` branch (i.e. [Pico's website](http://picocms.org/docs.html)) and vice verca. Unfortunately this involves three (!) different markdown parsers. If you're experiencing problems, use Pico's [`erusev/parsedown-extra`](https://github.com/erusev/parsedown-extra) as a reference. You can try to make the contents compatible to [Redcarpet](https://github.com/vmg/redcarpet) by yourself, otherwise please address the issues in your pull request message and we'll take care of it.
Versioning
----------
@ -65,7 +65,7 @@ Branching
The `master` branch contains the current development version of Pico. It is likely *unstable* and *not ready for production use*. However, the `master` branch always consists of a deployable version of Pico.
Picos actual development happens in separate development branches. Development branches are prefixed by:
Pico's actual development happens in separate development branches. Development branches are prefixed by:
- `feature/` for bigger features,
- `enhancement/` for smaller improvements, and

12
lib/Pico.php
View file

@ -4,7 +4,7 @@
* Pico
*
* Pico is a stupidly simple, blazing fast, flat file CMS.
* - Stupidly Simple: Picos makes creating and maintaining a
* - Stupidly Simple: Pico makes creating and maintaining a
* website as simple as editing text files.
* - Blazing Fast: Pico is seriously lightweight and doesn't
* use a database, making it super fast.
@ -83,7 +83,7 @@ class Pico
protected $themesDir;
/**
* Boolean indicating whether Picos processing started yet
* Boolean indicating whether Pico started processing yet
*
* @var boolean
*/
@ -477,9 +477,9 @@ class Pico
}
/**
* Sets Picos config before calling Pico::run()
* Sets Pico's config before calling Pico::run()
*
* This method allows you to modify Picos config without creating a
* This method allows you to modify Pico's config without creating a
* {@path "config/config.php"} or changing some of its variables before
* Pico starts processing.
*
@ -496,7 +496,7 @@ class Pico
public function setConfig(array $config)
{
if ($this->locked) {
throw new RuntimeException('You cannot modify Picos config after processing has started');
throw new RuntimeException("You cannot modify Pico's config after processing has started");
}
$this->config = $config;
@ -1214,7 +1214,7 @@ class Pico
}
/**
* Makes a relative path absolute to Picos root dir
* Makes a relative path absolute to Pico's root dir
*
* This method also guarantees a trailing slash.
*

8
plugins/00-PicoDeprecated.php
View file

@ -7,7 +7,7 @@
* It gets automatically enabled when a plugin which doesn't implement
* {@link PicoPluginInterface} is loaded. This plugin triggers deprecated
* events and automatically enables {@link PicoParsePagesContent} and
* {@link PicoExcerpt}. These plugins heavily impact Picos performance! You
* {@link PicoExcerpt}. These plugins heavily impact Pico's performance! You
* can disable this plugin by calling {@link PicoDeprecated::setEnabled()}.
*
* The following deprecated events are triggered by this plugin:
@ -36,7 +36,7 @@
* </pre>
*
* Since Pico 1.0 the config is stored in {@path "config/config.php"}. This
* plugin tries to read {@path "config.php"} in Picos root dir and overwrites
* plugin tries to read {@path "config.php"} in Pico's root dir and overwrites
* all settings previously specified in {@path "config/config.php"}.
*
* @author Daniel Rudolf
@ -98,7 +98,7 @@ class PicoDeprecated extends AbstractPicoPlugin
* Triggers the deprecated event config_loaded($config)
*
* This method also defines deprecated constants, reads the `config.php`
* in Picos root dir, enables the plugins {@link PicoParsePagesContent}
* in Pico's root dir, enables the plugins {@link PicoParsePagesContent}
* and {@link PicoExcerpt} and makes `$config` globally accessible (the
* latter was removed with Pico 0.9 and was added again as deprecated
* feature with Pico 1.0)
@ -160,7 +160,7 @@ class PicoDeprecated extends AbstractPicoPlugin
}
/**
* Read config.php in Picos root dir
* Read config.php in Pico's root dir
*
* @see PicoDeprecated::onConfigLoaded()
* @see Pico::loadConfig()

2
plugins/01-PicoParsePagesContent.php
View file

@ -7,7 +7,7 @@
* It gets automatically enabled when {@link PicoDeprecated} is enabled. You
* can avoid this by calling {@link PicoParsePagesContent::setEnabled()}.
*
* This plugin heavily impacts Picos performance, you should avoid to enable
* This plugin heavily impacts Pico's performance, you should avoid to enable
* it whenever possible! If you must parse the contents of a page, do this
* selectively and only for pages you really need to.
*

2
plugins/02-PicoExcerpt.php
View file

@ -8,7 +8,7 @@
* can avoid this by calling {@link PicoExcerpt::setEnabled()}.
*
* This plugin doesn't do its job very well and depends on
* {@link PicoParsePagesContent}, what heavily impacts Picos performance. You
* {@link PicoParsePagesContent}, what heavily impacts Pico's performance. You
* should either use the Description meta header field or write something own.
* Best solution seems to be a filter for twig, see e.g.
* {@link https://gist.github.com/james2doyle/6629712}.