Browse Source

fix(docs): More specific event doc changing

Signed-off-by: Joas Schilling <coding@schilljs.com>
pull/10731/head
Joas Schilling 2 years ago
parent
commit
e31ec75d26
No known key found for this signature in database GPG Key ID: 74434EFE0D2E2205
  1. 3
      lib/Events/CommandEvent.php
  2. 5
      tests/php/EventDocumentationTest.php

3
lib/Events/CommandEvent.php

@ -27,6 +27,9 @@ use OCA\Talk\Model\Command;
use OCA\Talk\Room;
use OCP\Comments\IComment;
/**
* @deprecated
*/
class CommandEvent extends ChatEvent {
protected string $output = '';

5
tests/php/EventDocumentationTest.php

@ -59,7 +59,10 @@ class EventDocumentationTest extends TestCase {
}
$docs = file_get_contents(__DIR__ . '/../../docs/events.md');
$eventIsDocumented = str_contains($docs, '`' . $eventClass . '`');
$eventIsDocumented = str_contains($docs, 'Before event: `' . $eventClass . '`')
|| str_contains($docs, 'After event: `' . $eventClass . '`')
|| str_contains($docs, 'Final event: `' . $eventClass . '`')
|| str_contains($docs, 'Event: `' . $eventClass . '`');
self::assertTrue($eventIsDocumented, 'Asserting that event ' . $eventClass . ' is documented');
}
}
Loading…
Cancel
Save