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

fix: update docs for the ts parser #12902

Merged
merged 1 commit into from May 12, 2018

Conversation

Projects
None yet
2 participants
@MarshallOfSound
Member

MarshallOfSound commented May 12, 2018

This is a follow up to #12900

Basically:

  • Don't document deprecated API's so they don't go into the definition file
  • That PR updates the TS tests to use the new API so that they pass
  • This PR also updates a few other ", or" situations that would cause issues

@MarshallOfSound MarshallOfSound requested review from electron/docs as code owners May 12, 2018

@zeke

zeke approved these changes May 12, 2018

@@ -184,7 +184,7 @@ of argument is notated by either the common types:
If an argument or a method is unique to certain platforms, those platforms are
denoted using a space-delimited italicized list following the datatype. Values
can be `macOS`, `Windows`, or `Linux`.
can be `macOS`, `Windows` or `Linux`.

This comment has been minimized.

@zeke

zeke May 12, 2018

Member

No oxford commas allowed, eh? 😛

@zeke

zeke May 12, 2018

Member

No oxford commas allowed, eh? 😛

This comment has been minimized.

@MarshallOfSound

MarshallOfSound May 12, 2018

Member

The docs parser doesn't understand them 😆

@MarshallOfSound

MarshallOfSound May 12, 2018

Member

The docs parser doesn't understand them 😆

@MarshallOfSound MarshallOfSound merged commit 0bb29e0 into master May 12, 2018

10 checks passed

WIP ready for review
Details
ci/circleci: electron-linux-arm Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-arm-test Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-arm64 Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-arm64-test Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-ia32 Your tests passed on CircleCI!
Details
ci/circleci: electron-linux-x64 Your tests passed on CircleCI!
Details
ci/circleci: electron-mas-x64 Your tests passed on CircleCI!
Details
ci/circleci: electron-osx-x64 Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details

@MarshallOfSound MarshallOfSound deleted the docs-updates-for-ts branch May 12, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment