Skip to content
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

Closed
peter-ahe-google opened this issue Dec 20, 2012 · 19 comments
Assignees
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. closed-duplicate Closed in favor of an existing report

Comments

@peter-ahe-google
Copy link
Contributor

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.

@dgrove
Copy link
Contributor

dgrove commented Dec 20, 2012

Set owner to amouravski@google.com.

@munificent
Copy link
Member

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.

@dgrove
Copy link
Contributor

dgrove commented Dec 21, 2012

Added this to the M3 milestone.

@peter-ahe-google
Copy link
Contributor Author

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.

@dgrove
Copy link
Contributor

dgrove commented Dec 21, 2012

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.

@DartBot
Copy link

DartBot commented Jan 22, 2013

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:
http://api.dartlang.org/docs/releases/latest/fixnum.html

Then I thought maybe it's on pub, went there and did a search for "fixnum", and it gives nothing:
http://pub.dartlang.org/search?q=fixnum

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.

@anders-sandholm
Copy link
Contributor

Removed this from the M3 milestone.
Added this to the M4 milestone.

@DartBot
Copy link

DartBot commented Mar 8, 2013

This comment was originally written by amouravski@google.com


Issue #8217 has been merged into this issue.

@larsbak
Copy link

larsbak commented May 28, 2013

Removed this from the M4 milestone.
Added this to the M5 milestone.

@DartBot
Copy link

DartBot commented Jun 28, 2013

This comment was originally written by amouravski@google.com


We are moving to a new documentation viewer.


Added WontFix label.

@peter-ahe-google
Copy link
Contributor Author

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.

@DartBot
Copy link

DartBot commented Jul 1, 2013

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.
Added this to the M6 milestone.
Removed Area-DartDoc label.
Added Area-Dartdoc-Next label.

@DartBot
Copy link

DartBot commented Jul 2, 2013

This comment was originally written by amouravski@google.com


Issue #10049 has been merged into this issue.

@DartBot
Copy link

DartBot commented Jul 2, 2013

This comment was originally written by amouravski@google.com


Issue #11635 has been merged into this issue.

@larsbak
Copy link

larsbak commented Aug 28, 2013

Removed this from the M6 milestone.
Added this to the M7 milestone.

@DartBot
Copy link

DartBot commented Oct 8, 2013

This comment was originally written by amouravski@google.com


Removed the owner.

@lrhn
Copy link
Member

lrhn commented Jan 28, 2014

Removed Area-Dartdoc-Next label.
Added Area-DartDocNext label.

@alan-knight
Copy link
Contributor

Removed this from the M7 milestone.

@anders-sandholm
Copy link
Contributor

Removed Area-DartDocNext label.
Added Area-DartDoc label.

@peter-ahe-google peter-ahe-google added Type-Defect area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. closed-duplicate Closed in favor of an existing report labels Feb 7, 2014
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-pkg Used for miscellaneous pkg/ packages not associated with specific area- teams. closed-duplicate Closed in favor of an existing report
Projects
None yet
Development

No branches or pull requests

9 participants