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
http://api.dartlang.org/ is documenting packages in dart/pkg, but these are not part of the Dart SDK #7540
Comments
Set owner to amouravski@google.com. |
I agree, we should move these docs off of api.dartlang.org. However, I'd like to wait until pub does support showing docs, which we plan to do in Q1. A lot of users rely on unittest and it would be really painful if those docs were just not available anywhere. Marking this as blocked on the bug to add dartdoc support to pub. Once that's done, we can remove these from api.dartlang.org easily. Marked this as being blocked by #5130. |
Added this to the M3 milestone. |
I don't see how pub's lack of support for documentation is related. I'm sure there are a lot of third-party packages that could use documentation, but they are not part of the platform, and should not be hosted alongside the platform documentation. |
I don't think we should take away docs that our users are using now. However, this does need to happen relatively quickly, which is why I put it in the M3 milestone. |
This comment was originally written by @Scorpiion Hi, I just wanted to say, as a user it is a bit misleading the way the docs are now. I first thought it was something wrong with my SDK when I realized that I did not have the "fixnum" package. You easily think it's part of the SDK when you see it here: Then I thought maybe it's on pub, went there and did a search for "fixnum", and it gives nothing: So, I think it's worth clearing up a bit, can be quite confusing for new users. I guess it will be fixed for M3, and I know that M3 is soon, just thought it still was worth mentioning. |
This comment was originally written by amouravski@google.com Issue #8217 has been merged into this issue. |
This comment was originally written by amouravski@google.com We are moving to a new documentation viewer. Added WontFix label. |
The packages must be removed from api.dartlang.org. It does not matter how the page is generated. I just checked, and api.dartlang.org still contain a number of non-dart packages. These must be removed. Added Triaged label. |
This comment was originally written by amouravski@google.com All of these problems will be resolved when Dartdoc-Next launches at the end of August. Unless there are burning problems with Dartdoc, I'm pushing this and other similar bugs into Area-Dartdoc-Next Removed this from the M5 milestone. |
This comment was originally written by amouravski@google.com Issue #10049 has been merged into this issue. |
This comment was originally written by amouravski@google.com Issue #11635 has been merged into this issue. |
This comment was originally written by amouravski@google.com Removed the owner. |
Removed Area-Dartdoc-Next label. |
Removed this from the M7 milestone. |
Removed Area-DartDocNext label. |
api.dartlang.org is documenting these pub packages:
fixnum
intl
logging
matcher
meta
mock
serialization
unittest
These packages should be document on pub, they are not part of the Dart SDK or the platform.
The text was updated successfully, but these errors were encountered: