Skip to content

Add return values for Application API methods #427

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

Merged

Conversation

skirtles-code
Copy link
Contributor

Fixes #423.

There didn't seem to be an established convention for what form these should take. I had a look at both the Vue 2 and Vue 3 docs before making some arbitrary choices:

  1. No name or type. In other contexts I might have included the type but for these methods I didn't think {Object} really added anything.
  2. The values are a sub-list within Returns, even though they typically only have a single list item.
  3. For the complicated cases (component and directive) I went for two items in the list rather than trying to cram it all into a single item.
  4. I used a capital letter at the start of each item but no full-stop at the end. My reasoning was that these aren't proper sentences, they're more like items on a shopping list or a to-do list.

I made a couple of other small changes, both of which are directly related to these return values.

Copy link
Member

@NataliaTepluhina NataliaTepluhina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for this contribution @skirtles-code! Changes look good to me 👍🏻

@NataliaTepluhina NataliaTepluhina merged commit 8d4d271 into vuejs:master Aug 25, 2020
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.

Return values for Application API methods
2 participants