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

Add a dedicated doc page for ValueConverter #3933

Open
Shane32 opened this issue Mar 13, 2024 · 4 comments
Open

Add a dedicated doc page for ValueConverter #3933

Shane32 opened this issue Mar 13, 2024 · 4 comments
Labels
documentation An issue or pull request regarding documentation improvements

Comments

@Shane32
Copy link
Member

Shane32 commented Mar 13, 2024

This issue participates in bounty program, see https://github.com/graphql-dotnet/graphql-dotnet/blob/master/BOUNTY.md

Bounty amount: $50

Tasks to be done:

[ORIGINAL POST BELOW]

I think we need a dedicated doc page for ValueConverter. Currently, it is only mentioned in the Custom Scalar page. But it has a wider usage now.

Originally posted by @gao-artur in #3932 (comment)

@macco3k
Copy link
Contributor

macco3k commented May 18, 2024

What would this page need to include?

@Shane32 Shane32 added the documentation An issue or pull request regarding documentation improvements label May 18, 2024
@Shane32
Copy link
Member Author

Shane32 commented May 18, 2024

Not exactly sure. Probably we should work up an outline before any writing is done. Any ideas? Keep in mind that this PR applies to GraphQL.NET v8 specifically, as we are expanding the use of ValueConverter in that version.

We could start with looking at the existing documentation, of course. Maybe we should document the process that GetArgument / ToObject goes through to convert a value into the requested type, and ValueConverter's relation to it.

@macco3k
Copy link
Contributor

macco3k commented May 18, 2024

I've not used ValueConverter myself, but from the little I can glimpse from that mention, it plays quite a big role in all the calls to GetArgument. Perhaps we should start with your suggestion and document what is already available.

@Shane32
Copy link
Member Author

Shane32 commented May 21, 2024

I added a bounty to this issue if you're interested in working on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation An issue or pull request regarding documentation improvements
Projects
None yet
Development

No branches or pull requests

2 participants