Docs for 'ls' say it returns names of objects, which is incorrect.

[GoogleCodeExporter]

The docs for the 'ls' command say:

"The ls command returns the names (and optionally the type names) of objects in 
the scene."

This is not true. The 'ls' command returns the objects themselves, not their 
names. This also makes it unclear what effect, if any, flags such as 'long' 
have on the result.

Maya 2012, Fedora Core 14, x64.
PyMEL 1.0.4rc2

Original issue reported on code.google.com by dean.edm...@gmail.com on 20 Jun 2012 at 6:58

[GoogleCodeExporter]

Unfortunately, currently most of the docs for wrapped mel commands are 
auto-generated from the corresponding maya.cmds docs, and we only add 
"modifications".

I'd like to do a more complete overhaul of the docs - at the very least, add in 
the ability to find/replace test to avoid confusing issues like this.

For now, I added in a note in the modifications section that it returns nodes, 
not names, and that flags that only alter names (like long) have no effect. 
(commit 5c535adb8ac8)

For the future, added a note to issue 226 to add in this find/replace feature

Original comment by elron...@gmail.com on 22 Jun 2012 at 12:10

[GoogleCodeExporter]

Setting this to fixed - refer to issue 226 for the documentation fixes we need 
to make

Original comment by elron...@gmail.com on 22 Jun 2012 at 12:11

• Changed state: Fixed