pub-dev icon indicating copy to clipboard operation
pub-dev copied to clipboard

API docs on pub don't interlink between packages

Open dcharkes opened this issue 2 years ago • 13 comments

Consider https://pub.dev/documentation/native_assets_cli/latest/native_assets_cli/BuildConfig/BuildConfig.fromConfig.html, the Config type is from https://pub.dev/documentation/cli_config/latest/cli_config/Config-class.html.

Would it be possible to generate the API docs in such a way that types from other packages can resolve to the API docs of said package?

dcharkes avatar Feb 26 '24 16:02 dcharkes

I believe this should happen automatically, we shall investigate why it is missing.

isoos avatar Feb 28 '24 09:02 isoos

A similar and maybe smaller case in shelf_router, the Handler class from package:shelf is not referenced: https://pub.dev/documentation/shelf_router/latest/shelf_router/Router-class.html

I don't see any trivially missing parameter from here: https://github.com/dart-lang/pana/blob/master/lib/src/sdk_env.dart#L436-L445

/cc @srawlins @kallentu @parlough any idea what we are missing here?

isoos avatar Feb 28 '24 12:02 isoos

We could add --link-to-remote, but it says (defaults to on).

But we probably need to reproduce locally.

jonasfj avatar Mar 06 '24 15:03 jonasfj