Skip to content

List markdown not rendered as an HTML list #1722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
chalin opened this issue Jul 4, 2018 · 5 comments
Closed

List markdown not rendered as an HTML list #1722

chalin opened this issue Jul 4, 2018 · 5 comments
Labels
customer-google3 Issues originating from or important to Angular P1 A high priority bug; for example, a single project is unusable or has many test failures

Comments

@chalin
Copy link
Contributor

chalin commented Jul 4, 2018

See https://github.com/dart-lang/sdk/blob/5b5e36f0be3994c7c889848cf0f5b210456afc59/pkg/meta/lib/meta.dart#L176-L189:

/// Used to annotate a named parameter `p` in a method or function `f`.
/// Indicates that every invocation of `f` must include an argument
/// corresponding to `p`, despite the fact that `p` would otherwise be an
/// optional parameter.
///
/// Tools, such as the analyzer, can provide feedback if
///
/// * the annotation is associated with anything other than a named parameter,
/// * the annotation is associated with a named parameter in a method `m1` that
///   overrides a method `m0` and `m0` defines a named parameter with the same
///   name that does not have this annotation, or
/// * an invocation of a method or function does not include an argument
///   corresponding to a named parameter that has this annotation.
const Required required = const Required();

This is rendered as follows (see https://pub.dartlang.org/documentation/meta/latest/meta/required-constant.html):

Used to annotate a named parameter p in a method or function f. Indicates that every invocation of f must include an argument corresponding to p, despite the fact that p would otherwise be an optional parameter.

Tools, such as the analyzer, can provide feedback if

the annotation is associated with anything other than a named parameter, the annotation is associated with a named parameter in a method m1 that overrides a method m0 and m0 defines a named parameter with the same name that does not have this annotation, or an invocation of a method or function does not include an argument corresponding to a named parameter that has this annotation.

cc @kwalrath @Sfshaza

@kwalrath
Copy link
Contributor

kwalrath commented Jul 6, 2018

And yet it's working in https://api.dartlang.org/be (the homepage has bullets). What's the difference?

@jcollins-g jcollins-g added the P2 A bug or feature request we're likely to work on label Jul 9, 2018
@jcollins-g
Copy link
Contributor

Homepage is rendered via a different path.

The whitespace / comment character stripping has been a cause of bugs like this before.

@Sfshaza
Copy link

Sfshaza commented Jul 11, 2018

I was wondering if it didn't work because of the 3-slashes - did you try 2?

I tried all sorts of things and couldn't get this to work properly on flutter.io.

@kwalrath
Copy link
Contributor

2 slashes wouldn't show up in the doc comment at all. This is just a bug, but a fairly serious one.

@jcollins-g can we please get a P1?

@jcollins-g jcollins-g added P1 A high priority bug; for example, a single project is unusable or has many test failures and removed P2 A bug or feature request we're likely to work on labels Jul 11, 2018
@jcollins-g
Copy link
Contributor

Elevating as bullet points not showing up correctly is a more widespread problem

@jcollins-g jcollins-g added the customer-google3 Issues originating from or important to Angular label Aug 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
customer-google3 Issues originating from or important to Angular P1 A high priority bug; for example, a single project is unusable or has many test failures
Projects
None yet
Development

No branches or pull requests

4 participants