Skip to content

Commit 8d572ba

Browse files
committed
Rename "_docs" to "docs".
Changelog excerpt: - Renaming "_docs" to "docs" to help with certain kinds of external tooling which seem to be entirely unable to detect documentation if said documentation isn't stored in a directory named specifically as "docs" (despite said documentation's location already being clearly identified in both the README file as well as the composer.json file).
1 parent 01e69f0 commit 8d572ba

20 files changed

Lines changed: 33 additions & 25 deletions

.gitattributes

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,4 @@
1616
/.gitattributes export-ignore
1717
/.github export-ignore
1818
/.gitignore export-ignore
19-
/_docs export-ignore
19+
/docs export-ignore

Changelog.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,14 @@ SigTool adheres to the SemVer guidelines for versioning.
55

66
Versioning guidelines for SemVer can be found at: https://semver.org/
77

8+
=== In development ===
9+
10+
- [2026.04.27]: Renaming "_docs" to "docs" to help with certain kinds of
11+
external tooling which seem to be entirely unable to detect documentation if
12+
said documentation isn't stored in a directory named specifically as "docs"
13+
(despite said documentation's location already being clearly identified in
14+
both the README file as well as the composer.json file).
15+
816
=== Version/Release 2.0.2 ===
917
PATCH RELEASE.
1018

CommonAbstract.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* Common abstract for the common classes package (last modified: 2026.03.17).
3+
* Common abstract for the common classes package (last modified: 2026.04.24).
44
*
55
* This file is a part of the "common classes package", utilised by a number of
66
* packages and projects, including CIDRAM and phpMussel.
@@ -20,7 +20,7 @@ abstract class CommonAbstract
2020
* @var string Common Classes Package tag/release version.
2121
* @link https://github.com/Maikuolan/Common/tags
2222
*/
23-
public const VERSION = '2.16.0';
23+
public const VERSION = '2.16.1';
2424

2525
/**
2626
* Traverse data path.

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -42,22 +42,22 @@ More information can be found in the documentation herein.
4242

4343

4444
### Documentation:
45-
- **[English](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.en.md)**
46-
- **[Deutsch](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.de.md)**
47-
- **[Español](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.es.md)**
48-
- **[Français](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.fr.md)**
49-
- **[Bahasa Indonesia](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.id.md)**
50-
- **[Italiano](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.it.md)**
51-
- **[日本語](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.ja.md)**
52-
- **[한국어](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.ko.md)**
53-
- **[Nederlandse](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.nl.md)**
54-
- **[Português](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.pt.md)**
55-
- **[Русский](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.ru.md)**
56-
- **[Tiếng Việt](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.vi.md)**
57-
- **[中文(简体)](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.zh-Hans.md)**
58-
- **[中文(傳統)](https://github.com/phpMussel/SigTool/blob/master/_docs/readme.zh-Hant.md)**
45+
- **[English](https://github.com/phpMussel/SigTool/blob/master/docs/readme.en.md)**
46+
- **[Deutsch](https://github.com/phpMussel/SigTool/blob/master/docs/readme.de.md)**
47+
- **[Español](https://github.com/phpMussel/SigTool/blob/master/docs/readme.es.md)**
48+
- **[Français](https://github.com/phpMussel/SigTool/blob/master/docs/readme.fr.md)**
49+
- **[Bahasa Indonesia](https://github.com/phpMussel/SigTool/blob/master/docs/readme.id.md)**
50+
- **[Italiano](https://github.com/phpMussel/SigTool/blob/master/docs/readme.it.md)**
51+
- **[日本語](https://github.com/phpMussel/SigTool/blob/master/docs/readme.ja.md)**
52+
- **[한국어](https://github.com/phpMussel/SigTool/blob/master/docs/readme.ko.md)**
53+
- **[Nederlandse](https://github.com/phpMussel/SigTool/blob/master/docs/readme.nl.md)**
54+
- **[Português](https://github.com/phpMussel/SigTool/blob/master/docs/readme.pt.md)**
55+
- **[Русский](https://github.com/phpMussel/SigTool/blob/master/docs/readme.ru.md)**
56+
- **[Tiếng Việt](https://github.com/phpMussel/SigTool/blob/master/docs/readme.vi.md)**
57+
- **[中文(简体)](https://github.com/phpMussel/SigTool/blob/master/docs/readme.zh-Hans.md)**
58+
- **[中文(傳統)](https://github.com/phpMussel/SigTool/blob/master/docs/readme.zh-Hant.md)**
5959

6060
---
6161

6262

63-
Last Updated: 1 July 2024 (2024.07.01).
63+
Last Updated: 27 April 2026 (2026.04.27).

YAML.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?php
22
/**
3-
* YAML handler (last modified: 2026.03.20).
3+
* YAML handler (last modified: 2026.04.27).
44
*
55
* This file is a part of the "common classes package", utilised by a number of
66
* packages and projects, including CIDRAM and phpMussel.
@@ -244,7 +244,7 @@ public function process(string $In, array &$Arr, int $Depth = 0, bool $Refs = fa
244244
/** Attempt to normalise encoding if not already UTF-8. */
245245
if ($this->LastInputEncoding !== 'UTF-8') {
246246
/** Suppress errors to avoid potentially flooding logs. */
247-
set_error_handler(function ($errno) {
247+
\set_error_handler(function ($errno) {
248248
return;
249249
});
250250

@@ -259,7 +259,7 @@ public function process(string $In, array &$Arr, int $Depth = 0, bool $Refs = fa
259259
$In = $Attempt;
260260

261261
/** We're done.. Restore the error handler. */
262-
restore_error_handler();
262+
\restore_error_handler();
263263
}
264264
}
265265

@@ -1041,7 +1041,7 @@ private function escapeKey(string $Key = ''): string
10411041
private function unescape(string $Value = '', string $Style = '"'): string
10421042
{
10431043
if ($Style === '"' || $Style === "\xe2\x80\x9c" || $Style === "\x91") {
1044-
set_error_handler(function ($errno) {
1044+
\set_error_handler(function ($errno) {
10451045
return;
10461046
});
10471047
$Value = \preg_replace([
@@ -1080,7 +1080,7 @@ private function unescape(string $Value = '', string $Style = '"'): string
10801080
return $Captured[1] . (($Attempt !== false && \strcmp($Reversed, $Decoded) === 0) ? $Attempt : $Decoded);
10811081
}, $Value);
10821082
$Value = \str_replace('\\\\', '\\', $Value);
1083-
restore_error_handler();
1083+
\restore_error_handler();
10841084
return $Value;
10851085
}
10861086
if ($Style === "'" || $Style === "\xe2\x80\x98" || $Style === "\x93") {
@@ -1570,7 +1570,7 @@ private function flattenTagNonScalar($In)
15701570
*
15711571
* @param mixed $In The scalar.
15721572
* @throws Error if provided an unsupported data type.
1573-
* @link https://github.com/Maikuolan/Common/blob/v2/_docs/YAML.md#supported-data-types
1573+
* @link https://github.com/Maikuolan/Common/blob/v2/docs/YAML.md#supported-data-types
15741574
* @return string The string.
15751575
*/
15761576
private function scalarToString($In): string

composer.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"support": {
77
"issues": "https://github.com/phpMussel/SigTool/issues",
88
"source": "https://github.com/phpMussel/SigTool",
9-
"docs": "https://github.com/phpMussel/SigTool/tree/master/_docs",
9+
"docs": "https://github.com/phpMussel/SigTool/tree/master/docs",
1010
"rss": "https://github.com/phpMussel/SigTool/releases.atom",
1111
"chat": "https://gitter.im/phpMussel2/Lobby"
1212
},
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)