atom.io API docs missing for a workspace item's optional methods

[jasonrudolph]

src/workspace.js defines the required and optional methods for a workspace item. The API docs on atom.io show the required methods, but the optional methods are missing from the docs for some reason:

[kodemonster]

How can we find out what methods should be listed there?

[winstliu]

Click on the first link in the issue.

[Aerijo]

@jasonrudolph Duplicate of #16106 (@WolfieMario posted first -_-)

On a related note, it's also stuffing up the options parameter properties of workspace.open. It's interpreted as an optional argument, and it's properties as arguments themselves. There may be more, but that's all I looked at.

[Aerijo]

It looks like the biggest difference between this and the config.js docs are that the headers have code in them. In particular, the description stops as soon as // #### `getTitle()` is reached, and workspace.js is the only file to match this regex pattern //\s*#{1,4} `

The docs are all there in jsMetadata, but they break after the call to tello.digest([metadata]).

[Aerijo]

I was wrong; the cause is a Returns anywhere in a paragraph. The parser has special handling for when the paragraph looks like a "return value", and will stop all further description making.

[Aerijo]

On a related note, it's also stuffing up the options parameter properties of workspace.open. It's interpreted as an optional argument, and it's properties as arguments themselves

The generated api JSON looks fine, with and without the fix for this issue. The format of Workspace.open matches that of TextEditor.setTextInBufferRange, which also has an options object. I don't know if I can debug that any further.

[kam773]

Can I work on this one?

[as-cii]

This seems to be related to #16106 and, as mentioned by @Aerijo, both issue can be tracked down to the same underlying cause. I am assigning myself to it because I already opened a few pull requests to fix #16106.