From dea58d5abdfb97056fb0da8e828f7eb5db468d17 Mon Sep 17 00:00:00 2001 From: YFdyh000 Date: Sun, 22 Aug 2021 21:32:05 +0800 Subject: [PATCH] trivial refine for messages --- .../front/controller/admin/ShaarliAdminController.php | 2 +- application/security/SessionManager.php | 2 +- doc/md/Backup-and-restore.md | 6 +++--- doc/md/dev/Development.md | 4 ++-- doc/md/dev/Unit-tests.md | 4 ++-- plugins/wallabag/wallabag.php | 2 +- tpl/default/configure.html | 8 ++++---- tpl/default/install.html | 4 ++-- tpl/default/pluginsadmin.html | 2 +- tpl/default/tools.html | 2 +- 10 files changed, 18 insertions(+), 18 deletions(-) diff --git a/application/front/controller/admin/ShaarliAdminController.php b/application/front/controller/admin/ShaarliAdminController.php index c26c9cbe..35fd1394 100644 --- a/application/front/controller/admin/ShaarliAdminController.php +++ b/application/front/controller/admin/ShaarliAdminController.php @@ -59,7 +59,7 @@ protected function saveErrorMessage(string $message): void /** * Use the sessionManager to save the provided message using the proper type. * - * @param string $type successed/warnings/errors + * @param string $type successes/warnings/errors */ protected function saveMessage(string $type, string $message): void { diff --git a/application/security/SessionManager.php b/application/security/SessionManager.php index f957b91a..ca186626 100644 --- a/application/security/SessionManager.php +++ b/application/security/SessionManager.php @@ -256,7 +256,7 @@ public function setSessionParameter(string $key, $value): self } /** - * Store a variable in user session. + * Delete a variable in user session. * * @param string $key Session key * diff --git a/doc/md/Backup-and-restore.md b/doc/md/Backup-and-restore.md index e7e2775c..0b92aee0 100644 --- a/doc/md/Backup-and-restore.md +++ b/doc/md/Backup-and-restore.md @@ -1,11 +1,11 @@ ## Backup and restore -All data and [configuration](Shaarli-configuration.md) is kept in the `data` directory. Backup this directory: +All data and [configuration](Shaarli-configuration.md) is kept in the `data` directory. Backup this directory: ```bash rsync -avzP my.server.com:/var/www/shaarli.mydomain.org/data ~/backups/shaarli-data-$(date +%Y-%m-%d_%H%M) ``` -It is strongly recommended to do periodic, automatic backups to a seperate machine. You can automate the command above using a cron job or full-featured backup solutions such as [rsnapshot](https://rsnapshot.org/) +It is strongly recommended to do periodic, automatic backups to a separate machine. You can automate the command above using a cron job or full-featured backup solutions such as [rsnapshot](https://rsnapshot.org/) -To restore a backup, simply put back the `data/` directory in place, owerwriting any existing files. \ No newline at end of file +To restore a backup, simply put back the `data/` directory in place, overwriting any existing files. diff --git a/doc/md/dev/Development.md b/doc/md/dev/Development.md index 260395ba..c51efd0b 100644 --- a/doc/md/dev/Development.md +++ b/doc/md/dev/Development.md @@ -160,7 +160,7 @@ See [`.github/workflows/`](https://github.com/shaarli/Shaarli/tree/master/.githu ### Documentation -[mkdocs](https://www.mkdocs.org/) is used to convert markdown documentation to HTML pages. The [public documentation](https://shaarli.readthedocs.io/en/master/) website is rendered and hosted by [readthedocs.org](https://readthedocs.org/). A copy of the documentation is also included in prebuilt [release archives](https://github.com/shaarli/Shaarli/releases) (`doc/html/` path in your Shaarli installation). To generate the HTML documentation locally, install a recent version of Python `setuptools` and run `make doc`. +[mkdocs](https://www.mkdocs.org/) is used to convert markdown documentation to HTML pages. The [public documentation](https://shaarli.readthedocs.io/en/master/) website is rendered and hosted by [readthedocs.org](https://readthedocs.org/). A copy of the documentation is also included in prebuilt [release archives](https://github.com/shaarli/Shaarli/releases) (`doc/html/` path in your Shaarli installation). To generate the HTML documentation locally, install a recent version of Python `setuptools` and run the `make doc`. ## Static analysis @@ -169,7 +169,7 @@ Patches should try to stick to the [PHP Standard Recommendations](http://www.php - [PSR-1](http://www.php-fig.org/psr/psr-1/) - Basic Coding Standard - [PSR-2](http://www.php-fig.org/psr/psr-2/) - Coding Style Guide -- [PSR-12](http://www.php-fig.org/psr/psr-12/) - Extended Coding Style Guide +- [PSR-12](http://www.php-fig.org/psr/psr-12/) - Extended Coding Style Guide These are enforced on pull requests using our Continuous Integration tools with [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer). diff --git a/doc/md/dev/Unit-tests.md b/doc/md/dev/Unit-tests.md index fd286bf0..e89eabdb 100644 --- a/doc/md/dev/Unit-tests.md +++ b/doc/md/dev/Unit-tests.md @@ -40,7 +40,7 @@ zend_extension=xdebug.so ## Run unit tests -Ensure tests pass successuflly: +Ensure tests pass successfully: ```bash make test @@ -110,7 +110,7 @@ Each image provides: - Shaarli PHP dependencies (OS packages) - test PHP dependencies (OS packages) - Composer -- Tests that run inside the conatiner using a standard Linux user account (running tests as `root` would bypass permission checks and may hide issues) +- Tests that run inside the container using a standard Linux user account (running tests as `root` would bypass permission checks and may hide issues) Build a test image: diff --git a/plugins/wallabag/wallabag.php b/plugins/wallabag/wallabag.php index f2003cb9..0fc3b862 100644 --- a/plugins/wallabag/wallabag.php +++ b/plugins/wallabag/wallabag.php @@ -69,7 +69,7 @@ function hook_wallabag_render_linklist($data, $conf) function wallabag_dummy_translation() { // meta - t('For each link, add a QRCode icon.'); + t("For each link, add a Wallabag icon to save it in your instance."); t('Wallabag API URL'); t('Wallabag API version (1 or 2)'); } diff --git a/tpl/default/configure.html b/tpl/default/configure.html index bb2564af..7bb8b372 100644 --- a/tpl/default/configure.html +++ b/tpl/default/configure.html @@ -49,7 +49,7 @@

{'Configure'|t}

@@ -95,7 +95,7 @@

{'Configure'|t}

@@ -222,7 +222,7 @@

{'Configure'|t}

@@ -270,7 +270,7 @@

{'Configure'|t}

diff --git a/tpl/default/install.html b/tpl/default/install.html index 4f98d49d..18cf0ef3 100644 --- a/tpl/default/install.html +++ b/tpl/default/install.html @@ -69,7 +69,7 @@

{'Install Shaarli'|t}

@@ -127,7 +127,7 @@

{'Install Shaarli'|t}