shelf icon indicating copy to clipboard operation
shelf copied to clipboard

DartDocs for `Pipeline` is broken.

Open renatoathaydes opened this issue 3 years ago • 3 comments
trafficstars

From Pipeline class:

/// Note: this package also provides `addMiddleware` and `addHandler` extensions
//  members on [Middleware], which may be easier to use.
class Pipeline {

Notice the final line in the docs starts with //, not ///. So it doesn't show up in the docs.

renatoathaydes avatar Aug 23 '22 20:08 renatoathaydes

Good catch! Interested in sending a PR for it?

devoncarew avatar Aug 23 '22 20:08 devoncarew

I will do that in exchange for you guys also letting me fix https://github.com/dart-lang/shelf/issues/270.

Deal?

renatoathaydes avatar Aug 24 '22 16:08 renatoathaydes

Fixing #270 seems reasonable; @kevmoo and @natebosch would be good reviewers for any PR for that. If the fix will be non-trival, you might want to discuss the solution in that issue, just so you can know ahead of time whether it's something we think we can accept.

devoncarew avatar Aug 24 '22 20:08 devoncarew