Vuex: Found text cut off in API Documentation

[Toltar]

Wanted to report that in the api documentation, there is cut off where it shows the arguments of the capture and dispatch methods. See image below.

[vue-bot]

Hello, your issue has been closed because it does not conform to our issue requirements. In order to ensure every issue provides the necessary information for us to investigate, we require the use of the Issue Helper when creating new issues. Thank you!

[fnlctrl]

Reopening as this is indeed an issue.

[Toltar]

Thanks @fnlctrl , I was unsure of how to report this type of issue on here.

[Jinjiang]

Guys how about this solution #1189 ? I have split the long api code into 2 pieces and placed them one-by-one together for workaround.
Thanks.

[Jinjiang]

[Toltar]

@Jinjiang For a permanent solution, could we provide subsections for each method in the documentation of Usage and Description for this? Such as:

Vuex Store Instance Methods

commit()

• Usages
  
  
  
  • commit(type: string, payload?: any, options?: Object)
  
  
  • commit(mutation: Object, options?: Object)
  
  
• Description
  
  
  
  • Commit a mutation. options can have root: true that allows to commit root mutations in namespaced modules. Details
  
  

[Jinjiang]

@Toltar Yes it's good.
There already are many docs such as vuex vue-router vue-loader vue-test-utils etc with the same format. It will cost a lot if we decide to make the change (I mean just leave the method name only in the header and add another "usages" section). Until now there are just two cases not OK and could be fixed another way easily. Maybe it's not necessary enough at this time imo. 🤔
@posva @chrisvfritz how do you think about it? 🙂
Thanks.

[Toltar]

@Jinjiang If it is a lot of work, I am willing to help on changing the overall formatting in the English markdown files. 😄 That is, if everyone agrees to it.

[chrisvfritz]

I think keeping one bullet-point per item would be best, but I don't have a problem with splitting it into multiple lines. 🙂

[ktsn]

This seems to be resolved by migrating vuepress.