Skip to content

Commit 6bfe0d6

Browse files
authored
Fix documentation rendering issues (#2264)
Replace `<` and `>` in documentation comments with `&lt` and `&gt` so that they won't be interpreted as HTML tags and will render as expected. In one place where we show Dart code with angle bracket I've replaced the wrapping `[` and `]` with backticks. Fixes CI.
1 parent 9fbbfdb commit 6bfe0d6

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

pkgs/checks/lib/src/checks.dart

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -908,17 +908,17 @@ final class CheckFailure {
908908
final class FailureDetail {
909909
/// A description of all the conditions the subject was expected to satisfy.
910910
///
911-
/// Each subject has a label. At the root the label is typically "a <Type>"
912-
/// and nested subjects get a label based on the condition which extracted a
913-
/// property for further checks. Each level of nesting is described as
914-
/// "<label> that:" followed by an indented list of the expectations for that
915-
/// property.
911+
/// Each subject has a label. At the root the label is typically "a
912+
/// &lt;Type&gt;" and nested subjects get a label based on the condition
913+
/// which extracted a property for further checks. Each level of nesting is
914+
/// described as "&lt;label&gt; that:" followed by an indented list of the
915+
/// expectations for that property.
916916
///
917917
/// For example:
918918
///
919919
/// a List that:
920920
/// has length that:
921-
/// equals <3>
921+
/// equals &lt;3&gt;
922922
final Iterable<String> expected;
923923

924924
/// A description of the conditions the checked value satisfied.
@@ -956,7 +956,7 @@ final class FailureDetail {
956956
///
957957
/// a List that:
958958
/// has length that:
959-
/// equals <3>
959+
/// equals &lt;3&gt;
960960
///
961961
/// If the actual value had an incorrect length, the [depth] will be `1` to
962962
/// indicate that the failure occurred checking one of the expectations

pkgs/test_core/lib/src/runner/hack_register_platform.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ final _platformCallbacks = <Runtime, FutureOr<PlatformPlugin> Function()>{};
2424
/// This globally registers a plugin for all [Loader]s. When the runner first
2525
/// requests that a suite be loaded for one of the given runtimes, this will
2626
/// call [plugin] to load the platform plugin. It may return either a
27-
/// [PlatformPlugin] or a [Future<PlatformPlugin>]. That plugin is then
27+
/// [PlatformPlugin] or a `Future<PlatformPlugin>`. That plugin is then
2828
/// preserved and used to load all suites for all matching runtimes.
2929
///
3030
/// This overwrites the default plugins for those runtimes.

0 commit comments

Comments
 (0)