Skip to content

Window docs missing info #6098

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

Closed
kwalrath opened this issue Oct 19, 2012 · 13 comments
Closed

Window docs missing info #6098

kwalrath opened this issue Oct 19, 2012 · 13 comments
Labels
area-documentation Prefer using 'type-documentation' and a specific area label. closed-obsolete Closed as the reported issue is no longer relevant docs-api

Comments

@kwalrath
Copy link
Contributor

http://api.dartlang.org/docs/continuous/dart_html/LocalWindow.html has almost no doc comments, but it has recently become a top-10 HTML API page (according to analytics).

Particular questions that came up in IRC:

  1. why does localwindow open a tab not a window
  2. Window open(String url, String name, [String options]) <- what options! :P
  3. interesting error when using some of Mozilla's arguements
       Exception: type '_DOMWindowCrossFrameImpl' is not a subtype of type 'LocalWindow' of 'ball'.
       Stack Trace: #­0 play.play

   RESPONSE: That means that the returned type is not a LocalWindow.
   Not sure what exactly it is, though.

@kwalrath
Copy link
Contributor Author

Yikes, LocalWindow has now disappeared.

@vsmenon
Copy link
Member

vsmenon commented Oct 23, 2012

There should be MDN docs. The generated code still has @­domName pointers.

  1. This shouldn't be a Dart thing. I.e., window.open in Dart should be equivalent to window.open in JS. Perhaps a browser config setting?
  2. https://developer.mozilla.org/en-US/docs/DOM/window.open
  3. That looks you're passing another frame's window object (Window) to a function that expects your own window (LocalWindow).

@kwalrath
Copy link
Contributor Author

Marked this as being blocked by #6213.

@kwalrath
Copy link
Contributor Author

A few of us were just talking about Window vs. LocalWindow, and we'd really like LocalWindow to be called Window (so it'll be easier to find). Here's a proposal for class names:

LocalWindow -> Window
Window -> BaseWindow

@kwalrath
Copy link
Contributor Author

Set owner to @vsmenon.

@DartBot
Copy link

DartBot commented Dec 19, 2012

This comment was originally written by [email protected]


I've started documentation on this, but do we have any more ideas on naming LocalWindow -> Window? blois?


cc @blois.
Set owner to [email protected].
Added Started label.

@blois
Copy link

blois commented Dec 19, 2012

We should make the LocalWindow->Window change soon. I opened bug http://code.google.com/p/dart/issues/detail?id=7516 to track.

I sort of prefer WindowBase to BaseWindow (seems more common as a suffix, and keeps it located close to Window when browsing).

Thoughts?

@DartBot
Copy link

DartBot commented Dec 19, 2012

This comment was originally written by [email protected]


Marked this as being blocked by #7516.

@DartBot
Copy link

DartBot commented Feb 28, 2013

This comment was originally written by [email protected]


Whoops. Edited wrong bug.


cc @blois.
Set owner to [email protected].
Unmarked this as being blocked by #8857.

@DartBot
Copy link

DartBot commented Apr 8, 2013

This comment was originally written by [email protected]


Removed Type-Defect label.
Added Type-Documentation label.

@kwalrath
Copy link
Contributor Author

Removed Area-DartDoc, Component-Docs, Type-Documentation labels.
Added Area-Documentation, Docs-API labels.

@kwalrath
Copy link
Contributor Author

Now that 13291 is fixed, mem should be able to make these changes.


Set owner to [email protected].
Marked this as being blocked by #13291.
Changed the title to: "Window docs missing info".

@kwalrath
Copy link
Contributor Author

Juniper has been updating these docs, so I think this is stale?


Added AssumedStale label.

@kwalrath kwalrath added Priority-Medium area-documentation Prefer using 'type-documentation' and a specific area label. docs-api closed-obsolete Closed as the reported issue is no longer relevant labels Nov 27, 2013
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-documentation Prefer using 'type-documentation' and a specific area label. closed-obsolete Closed as the reported issue is no longer relevant docs-api
Projects
None yet
Development

No branches or pull requests

4 participants