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

Update the dart:html API docs #30253

Closed
Sfshaza opened this issue Jul 24, 2017 · 8 comments
Closed

Update the dart:html API docs #30253

Sfshaza opened this issue Jul 24, 2017 · 8 comments
Assignees
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. docs-api library-html type-documentation A request to add or improve documentation

Comments

@Sfshaza
Copy link

Sfshaza commented Jul 24, 2017

I'm deleting the "Improving the Dom" article from webdev.dartlang. It's old, but it has some accurate info about the dart:html library. Please import the relevant/useful bits to the dart:html library page.

You can find the article on the wayback machine.

@a-siva a-siva added the area-documentation Prefer using 'type-documentation' and a specific area label. label Jul 25, 2017
@kwalrath
Copy link
Contributor

I just noticed that https://api.dartlang.org/stable/dart-html has lots of missing whitespace. Not sure if this is in the source code or is dartdoc's fault.

image

/cc @jcollins-g

@alan-knight
Copy link
Contributor

It seems like line breaks are not being interpreted as whitespace. And presumably they were before.

@kwalrath
Copy link
Contributor

I wonder if this only affects bulleted lists.

@jcollins-g
Copy link
Contributor

This may be related to dart-lang/dartdoc#1435

@kwalrath
Copy link
Contributor

kwalrath commented Jun 26, 2018

The whitespace issues are gone now, but this page still needs to be updated. At the very least, we should delete the "Other resources" section entirely, and add a link to webdev.dartlang.org. Something like this:

For information on writing web apps with Dart, see webdev.dartlang.org.

@kwalrath
Copy link
Contributor

@terrylucas, what's the best way to get the dart:html library description updated? (I can do it... I'm just not sure what the process would be.)

@srawlins srawlins added area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. type-documentation A request to add or improve documentation and removed area-documentation Prefer using 'type-documentation' and a specific area label. labels Jun 27, 2018
@terrylucas
Copy link
Contributor

Kathy here's the change https://dart-review.googlesource.com/c/sdk/+/62642 let me know if this works?

@kwalrath
Copy link
Contributor

It looks great at https://api.dartlang.org/be/dart-html/dart-html-library.html. Thanks, @terrylucas!

(It'll take a while until it shows up on stable, of course.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-core-library SDK core library issues (core, async, ...); use area-vm or area-web for platform specific libraries. docs-api library-html type-documentation A request to add or improve documentation
Projects
None yet
Development

No branches or pull requests

7 participants