Skip to content

Commit cbe30e6

Browse files
committed
clean other directives
1 parent 00ba70f commit cbe30e6

File tree

7 files changed

+23
-82
lines changed

7 files changed

+23
-82
lines changed

_build/src/Directive/AbstractAdmonitionDirective.php

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,8 @@ public function __construct(string $name, string $text)
2121
$this->text = $text;
2222
}
2323

24-
final public function processSub(
25-
Parser $parser,
26-
?Node $document,
27-
string $variable,
28-
string $data,
29-
array $options
30-
): ?Node {
24+
final public function processSub(Parser $parser, ?Node $document, string $variable, string $data, array $options): ?Node
25+
{
3126
return new WrapperNode(
3227
$document,
3328
sprintf(

_build/src/Directive/ClassDirective.php

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,16 @@ public function getName(): string
1515
return 'class';
1616
}
1717

18-
public function processSub(
19-
Parser $parser,
20-
?Node $document,
21-
string $variable,
22-
string $data,
23-
array $options
24-
): ?Node {
18+
public function processSub(Parser $parser, ?Node $document, string $variable, string $data, array $options): ?Node
19+
{
2520
if (!$document instanceof ListNode && !$document instanceof ParagraphNode) {
26-
throw new \RuntimeException('Class could only be applied to paragraphs or lists');
21+
throw new \RuntimeException(
22+
sprintf(
23+
"\".. class:\" directive could only be applied to paragraphs or lists (applied to \"%s\")\nTarget block:\n%s",
24+
\get_class($document),
25+
$document->render()
26+
)
27+
);
2728
}
2829

2930
$document->setClass($data);

_build/src/Directive/CodeBlockDirective.php

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,46 +6,23 @@
66
use Doctrine\RST\Nodes\CodeNode;
77
use Doctrine\RST\Nodes\Node;
88
use Doctrine\RST\Parser;
9-
use function array_reverse;
10-
use function assert;
11-
use function is_array;
12-
use function is_string;
13-
use function preg_split;
14-
use function trim;
159

16-
/**
17-
* Renders a code block, example:
18-
*
19-
* .. code-block:: php
20-
*
21-
* <?php
22-
*
23-
* echo "Hello world!\n";
24-
*/
2510
class CodeBlockDirective extends Directive
2611
{
2712
public function getName(): string
2813
{
2914
return 'code-block';
3015
}
3116

32-
/**
33-
* @param string[] $options
34-
*/
35-
public function process(
36-
Parser $parser,
37-
?Node $node,
38-
string $variable,
39-
string $data,
40-
array $options
41-
): void {
17+
public function process(Parser $parser, ?Node $node, string $variable, string $data, array $options): void
18+
{
4219
if (!$node instanceof CodeNode) {
4320
return;
4421
}
4522

4623
$node->setLanguage($data);
4724

48-
if ($variable !== '') {
25+
if ('' !== $variable) {
4926
$environment = $parser->getEnvironment();
5027
$environment->setVariable($variable, $node);
5128
} else {

_build/src/Directive/ConfigurationBlockDirective.php

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,8 @@ public function getName(): string
1717
return 'configuration-block';
1818
}
1919

20-
/**
21-
* @param string[] $options
22-
*/
23-
public function processSub(
24-
Parser $parser,
25-
?Node $document,
26-
string $variable,
27-
string $data,
28-
array $options
29-
): ?Node {
20+
public function processSub(Parser $parser, ?Node $document, string $variable, string $data, array $options): ?Node
21+
{
3022
if (!$document instanceof Document) {
3123
return null;
3224
}

_build/src/Directive/RoleDirective.php

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,13 @@
99

1010
class RoleDirective extends SubDirective
1111
{
12-
public function getName() : string
12+
public function getName(): string
1313
{
1414
return 'role';
1515
}
1616

17-
/**
18-
* @param string[] $options
19-
*/
20-
public function processSub(
21-
Parser $parser,
22-
?Node $document,
23-
string $variable,
24-
string $data,
25-
array $options
26-
) : ?Node {
17+
public function processSub(Parser $parser, ?Node $document, string $variable, string $data, array $options): ?Node
18+
{
2719
return new WrapperNode($document, '<div class="role">', '</div>');
2820
}
2921
}

_build/src/Directive/SidebarDirective.php

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,8 @@ public function getName(): string
1414
return 'sidebar';
1515
}
1616

17-
/**
18-
* @param string[] $options
19-
*/
20-
public function processSub(
21-
Parser $parser,
22-
?Node $document,
23-
string $variable,
24-
string $data,
25-
array $options
26-
): ?Node {
17+
public function processSub(Parser $parser, ?Node $document, string $variable, string $data, array $options): ?Node
18+
{
2719
return new WrapperNode(
2820
$document,
2921
sprintf('<div class="admonition-wrapper"><div class="sidebar"></div><div class="admonition admonition-sidebar"><p class="sidebar-title">%s</p>', $data),

_build/src/Directive/VersionAddedDirective.php

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,8 @@ public function getName(): string
1414
return 'versionadded';
1515
}
1616

17-
/**
18-
* @param string[] $options
19-
*/
20-
public function processSub(
21-
Parser $parser,
22-
?Node $document,
23-
string $variable,
24-
string $data,
25-
array $options
26-
): ?Node {
17+
public function processSub(Parser $parser, ?Node $document, string $variable, string $data, array $options): ?Node
18+
{
2719
return new WrapperNode(
2820
$document,
2921
sprintf('<div class="versionadded"><div><span class="versionmodified">New in version %s: </span>', $data),

0 commit comments

Comments
 (0)