Fix(docs): Use 'prop drilling' terminology and add glossary entry (fixes #12828) #12862
Conversation
Summary of ChangesHello @sfshaza2, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on improving the clarity and consistency of documentation by refining terminology related to state management. It addresses a specific instance where a common data-passing pattern was ambiguously described, ensuring that readers encounter precise and widely understood terms. The change also includes adding the newly emphasized term to the project's glossary, making it easier for users to find definitions and related information. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request improves the documentation by replacing the term 'dependency injection' with the more specific and accurate 'prop drilling' in the state management guide. It also adds a new entry for 'prop drilling' to the glossary, which is a great addition for clarity. The changes are well-executed. I have one minor suggestion regarding formatting in the glossary file to ensure consistency.
|
|
||
|
|
There was a problem hiding this comment.
There's an extra blank line here. For consistency with the rest of the file, glossary entries should be separated by a single blank line. Please remove one of the blank lines.
|
Visit the preview URL for this PR (updated for commit 726fbc4): https://flutter-docs-prod--pr12862-fix-12828-clean-cc66kut0.web.app |
parlough
left a comment
parlough
left a comment
There was a problem hiding this comment.
Generally looks good to me, just two small questions/concerns:
| makes it clear to anyone reading the code that there are shared dependencies. | ||
| This is a common design pattern called _dependency injection_ | ||
| and many frameworks take advantage of it or provide tools to make it easier. | ||
| However, creating a chain of widgets that only pass data down to their children |
There was a problem hiding this comment.
What is "However" referring to here? Could it just be dropped?
| This is a common design pattern called _dependency injection_ | ||
| and many frameworks take advantage of it or provide tools to make it easier. | ||
| However, creating a chain of widgets that only pass data down to their children | ||
| is often referred to as _prop drilling_. |
There was a problem hiding this comment.
Consider cross linking this to the glossary entry you added: /resources/glossary#prop-drilling
|
|
||
| - term: "Prop drilling" | ||
| short_description: |- | ||
| The process of passing data through multiple layers of widgets via constructors. |
There was a problem hiding this comment.
https://developers.google.com/style/word-list#via suggests not using "via".
Could "through constructor parameters" work instead?
| short_description: |- | ||
| The process of passing data through multiple layers of widgets via constructors. | ||
| long_description: |- | ||
| The process of passing data through multiple layers of widgets via constructors, |
3 participants
Resolves #12828 by updating 'state-management.md' to explicitly use the term 'prop drilling' for the constructor-based data passing pattern, replacing the confusing 'dependency injection' reference in that specific context. Also adds 'Prop drilling' to the glossary.