1337465 - JS shell namespace objects have poor help strings

Status: RESOLVED FIXED

(Core :: JavaScript Engine, defect)

Description

[Steve Fink [:sfink] [:s:]]

js> help(os.file)
os.file - interface object
  os.file.readFile os.file.readRelativeToScript os.file.writeTypedArrayToFile os.file.redirect os.file.redirectErr os.file.close

Comment 1

[Steve Fink [:sfink] [:s:]]

Attachment: Create proper help strings for JS shell namespace objects

I'm not sure who to use for my shell-related reviews. So I'll pick on you by default.

With this patch:

js> help(os.file)
os.file - interface object
  readFile(filename, ["binary"])
  readRelativeToScript(filename, ["binary"])
  writeTypedArrayToFile(filename, data)
  redirect([path-or-object])
  redirectErr([path-or-object])
  close(object)

I've long had plans to split up the huge pile of shell functions into namespaces. It'll probably never happen and should perhaps be replaced with spidernode anyway, but I'll still incrementally move that way when I have the chance.

Comment 2

[Jon Coppeard (:jonco) (PTO until 27th Jan)]

Comment on attachment 8834519 [details] [diff] [review]
Create proper help strings for JS shell namespace objects

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

::: js/src/shell/jsshell.cpp
@@ +102,1 @@
>      return true;

Should this return false if the specified property wasn't found?

Comment 3

[Steve Fink [:sfink] [:s:]]

(In reply to Jon Coppeard (:jonco) from comment #2)
> Comment on attachment 8834519 [details] [diff] [review]
> Create proper help strings for JS shell namespace objects
> 
> Review of attachment 8834519 [details] [diff] [review]:
> -----------------------------------------------------------------
> 
> ::: js/src/shell/jsshell.cpp
> @@ +102,1 @@
> >      return true;
> 
> Should this return false if the specified property wasn't found?

Oh, good point. I could just assert. But maybe we do oom simulation during startup? Yeah, I'll throw. Thanks.

Comment 4

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/1d4116cb3c9d
Create proper help strings for JS shell namespace objects, r=jonco

Comment 5

[Wes Kocher (:KWierso) (Not reading bugmail; email directly if needed)]

https://hg.mozilla.org/mozilla-central/rev/1d4116cb3c9d