802989 - [OS.File] Fix documentation of OS.Path

Status: RESOLVED FIXED

(Toolkit Graveyard :: OS.File, defect)

Description

[David Teller [:Yoric] - still alive but not very active]

Documentation of OS.Path still uses OS.Path.to. This should be updated.

Comment 1

[David Teller [:Yoric] - still alive but not very active]

I should add that this is the *in source* documentation, not the MDN hosted doc.

Comment 2

[:Cykesiopka]

Attachment: Proposed Patch v1

Hopefully this is what you wanted...

Comment 3

[David Teller [:Yoric] - still alive but not very active]

Comment on attachment 728562 [details] [diff] [review]
Proposed Patch v1

Review of attachment 728562 [details] [diff] [review]:
-----------------------------------------------------------------

That's what I wanted indeed. I believe that it would be slightly easier to read in two lines, though, as it was before:
  var tmpDir = ...
  var path = ...

Comment 4

[:Cykesiopka]

Attachment: Patch v2

Reverted to two lines, as before.

The MDN docs use the single line version as the example... Should I update that as well?

Comment 5

[:Cykesiopka]

Oops, is this one of those situations where I can "carry r+"? Still not very familiar with the review system unfortunately...

Comment 6

[David Teller [:Yoric] - still alive but not very active]

Comment on attachment 728600 [details] [diff] [review]
Patch v2

Review of attachment 728600 [details] [diff] [review]:
-----------------------------------------------------------------

Yes, you could carry the r+.
And yes, if you could update the MDN version, that would be great.

Thanks for the patch!

Comment 7

[:Cykesiopka]

No problem!

I've updated the MDN docs as well.

Comment 8

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/f15682d66f5f

Comment 9

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/mozilla-central/rev/f15682d66f5f