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

Improve the API section of the readme #239

Merged
merged 12 commits into from May 13, 2019
Merged

Conversation

ehmicky
Copy link
Collaborator

@ehmicky ehmicky commented May 12, 2019

This improves the API section:

  • the description of each property of the return/resolved value (or thrown/rejected error) was missing.
  • the return value of execa.sync() was wrong (it is not the same as the return value of spawnSync() although it has some common properties.
  • the extra methods and properties of the child_process instance returned by the main function are now separate.
  • the description of the main function has been improved.

To be more efficient, I will update the index.d.ts file after a first code review.

readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
readme.md Outdated Show resolved Hide resolved
@ehmicky
Copy link
Collaborator Author

ehmicky commented May 12, 2019

Fixed! I've also fixed the index.d.ts.

@sindresorhus sindresorhus changed the title Improve the API section of the README Improve the API section of the readme May 13, 2019
@sindresorhus sindresorhus merged commit 0d39fdf into master May 13, 2019
@sindresorhus sindresorhus deleted the feature/improve-readme branch May 13, 2019 15:49
@sindresorhus
Copy link
Owner

Looks good :)

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.

None yet

2 participants