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

WIP: Fix JS Doc comments in Vue Apollo queries #3715

Closed
wants to merge 1 commit into from

Conversation

GavinRay97
Copy link

Currently, because of the type declaration placed before the exported function in queries, it does not pick up the JSDoc docstring:

image

image

image

Adding @param variables and moving the type below the function makes it work properly:

image

image

I am unable to test these changes properly because I wasn't able to find documentation on the development workflow for modifying existing plugins.

I tried running the build script from the main repo and using the index.cjs.js, but during the codegen process it errors due to there being "duplicate copies of graphql library":

ensure there is only one instance of graphql

@iskanderbroere
Copy link
Contributor

The jsdoc bug (it being in the wrong place) is fixed in #3891 because of some refactoring in the code, removing the generation of the ReactiveFunction type and therefore putting the jsdoc in the right place. It'd be nice if you could improve the generation of jsdoc with @params tho 😄

@GavinRay97
Copy link
Author

@iskanderbroere Amazing, thank you!

Just curious, what is the development workflow for working on plugins? I couldn't find anything in the docs or contributing documentation.

@dotansimha
Copy link
Owner

@GavinRay97 We are updating it now, see #3712 (comment)

And thank you for this PR, we'll go with #3891 because it includes this as well.

@dotansimha dotansimha closed this Apr 19, 2020
@GavinRay97 GavinRay97 deleted the patch-1 branch April 19, 2020 22:09
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.

3 participants