707745 - Documentation for self.data.url misstates return type

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect, P3)

Description

[Michael Hanson]

The self.data.URL method claims to return a URL instance.  As of 12-5-11 it is returning a String.

Comment 1

[Erik Vold]

I'm taking a look at how many tests break when self.data.URL returns a URL instance, if it seems bad then we should probably just change the docs.

Comment 2

[Erik Vold]

Attachment: Pointer to Github pull request: https://github.com/mozilla/addon-sdk/pull/303

Pointer to Github pull-request

Comment 3

[Irakli Gozalishvili [:irakli] [:gozala] [@gozala]]

In fact I think it makes more sense to change docs anyway. I know some people pass it through the message to the content which works just fine for strings. What do you think myk ?

Comment 4

[Erik Vold]

(In reply to Irakli Gozilalishvili [:irakli] [:gozala] from comment #3)
> I know some
> people pass it through the message to the content which works just fine for
> strings.

What example wonn't work after bug 708168?

Comment 5

[Erik Vold]

(In reply to Erik Vold from comment #4)
> (In reply to Irakli Gozilalishvili [:irakli] [:gozala] from comment #3)
> > I know some
> > people pass it through the message to the content which works just fine for
> > strings.
> 
> What example wonn't work after bug 708168?

There should be a test for it.

Comment 6

[Erik Vold]

(In reply to Erik Vold from comment #4)
> (In reply to Irakli Gozilalishvili [:irakli] [:gozala] from comment #3)
> > I know some
> > people pass it through the message to the content which works just fine for
> > strings.
> 
> What example wonn't work after bug 708168?

ah I think I know what you meant now, JSON.stringify() will treat a URL differently than a string.. So, I agree with you now.

I'll make a new patch to just change the docs, and include a JSON.stringify test of URL, even though testing Object.keys in combo with other tests are doing basically the same thing..

Comment 7

[Erik Vold]

(In reply to Erik Vold from comment #5)
> (In reply to Erik Vold from comment #4)
> > (In reply to Irakli Gozilalishvili [:irakli] [:gozala] from comment #3)
> > > I know some
> > > people pass it through the message to the content which works just fine for
> > > strings.
> > 
> > What example wonn't work after bug 708168?
> 
> There should be a test for it.

I guess this was the test that the output is a string, which I changed =]

Comment 8

[Erik Vold]

Attachment: Pointer to Github pull request: https://github.com/mozilla/addon-sdk/pull/304

Pointer to Github pull-request

Comment 9

[[github robot]]

Commit pushed to https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/cbe2870f560d77f404b6b7bbd70f6d758259b894
Merge pull request #304 from erikvold/bug-707745c

fix Bug 707745 minor correction to docs of self module r=@gozala