Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
jasonrudolph opened this issue Jul 25, 2018 · 4 comments

Comments

Projects
None yet
4 participants
@jasonrudolph
Copy link
Member

commented Jul 25, 2018

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:

screen shot 2018-07-25 at 14 39 45 pm

@kodemonster

This comment has been minimized.

Copy link

commented Nov 18, 2018

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

@50Wliu

This comment has been minimized.

Copy link
Member

commented Nov 19, 2018

Click on the first link in the issue.

@Aerijo

This comment has been minimized.

Copy link
Member

commented Jan 25, 2019

@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

This comment has been minimized.

Copy link
Member

commented Mar 4, 2019

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]).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.