Skip to content

fix docs description #1679

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
merged 1 commit into from
Feb 27, 2020
Merged

fix docs description #1679

merged 1 commit into from
Feb 27, 2020

Conversation

PeterChen1997
Copy link
Contributor

I think this 'action' maybe is not the action in Vuex? Maybe using 'mutation' in docs is more specific
I check the englinsh docs, and it's the same word 'action'...
Maybe I misunderstand the mean

@kiaking kiaking added the documentation Improvements or additions to documentation label Feb 13, 2020
@kiaking
Copy link
Member

kiaking commented Feb 13, 2020

Yeah, you're right. It says action, but the code example is actually committing a mutation. It's bit confusing. But however, the word "action" could sound like it's referring to a method or function.

So to get rid of this confusion, how about renaming it to "method" instead?

Also, we need to change all other langs as well 😝

@PeterChen1997
Copy link
Contributor Author

PeterChen1997 commented Feb 15, 2020

Yeah, you're right. It says action, but the code example is actually committing a mutation. It's bit confusing. But however, the word "action" could sound like it's referring to a method or function.

So to get rid of this confusion, how about renaming it to "method" instead?

Also, we need to change all other langs as well 😝

Hi king, i found that problem had been fixed in the master branch. But the online docs is using the dev branch. So what can i help😝 @kiaking

@kiaking
Copy link
Member

kiaking commented Feb 26, 2020

Oh, thank you so much for the check! Let me check how doc deploy things work 🤔 I'll come back to you.

@kiaking
Copy link
Member

kiaking commented Feb 27, 2020

@PeterChen1997 OK I've checked. Well currently, dev branch is the master for the Vuex (same for Vue Router, etc.) so master branch is old one, and dev needs to be fixed.

But I think docs are managed by community members mainly, could you change the word mutation to method instead? and also the same part in English doc? (So that other lang contributors might notice).

I think this 'action' maybe is not the action in Vuex? Maybe using 'mutation' in docs is more specific
I check the englinsh docs, and it's the same word 'action'...
Maybe I misunderstand the mean

docs: fix docs desc in forms part
@PeterChen1997
Copy link
Contributor Author

@kiaking Thx for your patient reply, i had fixed the docs' problem in chinese and english version. If there is any problem, you can call me back~

@kiaking
Copy link
Member

kiaking commented Feb 27, 2020

@PeterChen1997 Thanks a bunch! 👍

@ktsn Could you final check this? I think this change would make more sense and reduce users confusion.

Copy link
Member

@ktsn ktsn left a comment

Choose a reason for hiding this comment

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

LGTM

@kiaking
Copy link
Member

kiaking commented Feb 27, 2020

Nice! Let's merge this baby then 👍 Thank you so much for your contribution @PeterChen1997 🎉

@kiaking kiaking merged commit 09330b0 into vuejs:dev Feb 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants