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

Updated formatting on API.md #1090

Merged
merged 1 commit into from
Mar 9, 2017
Merged

Updated formatting on API.md #1090

merged 1 commit into from
Mar 9, 2017

Conversation

elussich
Copy link
Contributor

@elussich elussich commented Mar 8, 2017

Note: the socket.io.js file is the generated output of make socket.io.js, and should not be manually modified.

The kind of change this PR does introduce

  • a bug fix
  • a new feature
  • an update to the documentation
  • a code change that improves performance
  • other

Current behaviour

Formatting was broken on the Manager section, under "new Manager / options" object. It's not a big deal, but because of this, I was not being able to find the specific path property, which was critical for my own socket.io implementation.

New behaviour

path property will be displayed into a new line, as part of the properties list for the options object.

Other information (e.g. related issues)

The diff view may not show the actual results; you'd need to see the API.md as parsed html.

Formatting was broken on the *Manager* section, under "new Manager / options" object. It's not a big deal, but because of this, I was not being able to find the specific `path` property, which was critical for my own socket.io implementation.
@darrachequesne darrachequesne merged commit 25321d1 into socketio:master Mar 9, 2017
@darrachequesne
Copy link
Member

Thanks!

@darrachequesne darrachequesne added this to the 2.0.0 milestone Jun 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants