Skip to content

[Documentation][ValueResolvers] add example Value Resolvers #19427

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

Closed

Conversation

ghost
Copy link

@ghost ghost commented Jan 16, 2024

I observed that the documentation lacked references and examples to elucidate the various types of value resolvers.

@carsonbot carsonbot added this to the 7.1 milestone Jan 16, 2024
@ghost ghost force-pushed the docs/examples-value-resolver branch from 154dd7d to d828512 Compare January 16, 2024 14:30
@javiereguiluz
Copy link
Member

Thanks for this proposal.

The problem with adding these examples is that we need to reformat the original docs. Why? Becuase they are displayed as a short list of items. If we add examples, the list is going to be very long and it will look bad when rendered.

So, asking to Symfony Doc maintainers (@OskarStark, @wouterj and @xabbuh): do you think we should refactor this list into a series of small h3 or h4 section per resolver to add an example ... or maybe we could just not include these examples? Thanks!

@javiereguiluz javiereguiluz added the Waiting team decision Request for comments from Symfony Docs Team members label Jan 17, 2024
@ghost
Copy link
Author

ghost commented Jan 24, 2024

I understand. Would you like me to reduce the examples, just indicating the route and the function name?
Example :

#[Route('/exemple/{$donneesProduit}')]
public function afficherProduit(string $donneesProduit): Response
{
    // ...
}

Or would you rather wait for Symfony Doc maintainers opinion?

@OskarStark
Copy link
Contributor

I like having examples 👍

@ghost
Copy link
Author

ghost commented Jan 25, 2024

Hi ! @OskarStark .

I'd like to know whether I should keep the original proposal or make some changes to the examples, as indicated in my previous message.

@ghost ghost closed this by deleting the head repository Jul 3, 2025
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Needs Review Waiting team decision Request for comments from Symfony Docs Team members
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants