Merge release 3.1.1 into 3.2.x #31
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Close #21
Signed-off-by: Geert Eltink <[email protected]>
Signed-off-by: Geert Eltink <[email protected]>
Signed-off-by: Geert Eltink <[email protected]>
Correction according to method definition
Signed-off-by: Vytautas Stankus <[email protected]>
The intent here isn't to make this in to a marketing piece, rather to provide a succinct, yet also sufficiently descriptive snapshot overview/introduction to what laminas-hydrator is. It's aimed at people who are seeing the package/component for the first time and need to quickly know what it is. I hope that this change does that, and gives them incentive to delve deeper. Signed-off-by: Matthew Setter <[email protected]>
The intent of this change is to make the content far more accessible to first time readers. The changes include: 1. Update the introductory content to build upon the core description in index.md. This time, the user is a step deeper, and seeking to learn more. So this description takes them that bit deeper, providing them quick and easy access to the next level down in to the component. 2. As they're still new to the package, it brings the usage section right up near the top, so that they can get a sample of how the package works and what they can expect. 3. It moves the available implementations to after the usage section, simplifies the headers and descriptions of each one, and adds a usage example for any that don't have one. The reason for this is that, to me, using the FQN as the section header is redundant and too verbose. The descriptions were reworked to read a little more like a narrative, yet still maintain the focus of a core documentation guide. I tried hard to make the text flow, yet still be active and to the point. There should be usage examples for each one, as you can never be sure which one the user may be most interested in, which one they need, and for completeness sake. I also sorted the hydrators in to what seemed to be the most applicable order of complexity, from the most basic to the most advanced. Signed-off-by: Matthew Setter <[email protected]>
Signed-off-by: Matthew Setter <[email protected]>
Signed-off-by: Matthew Setter <[email protected]>
Signed-off-by: Matthew Setter <[email protected]>
Signed-off-by: Matthew Setter <[email protected]>
Signed-off-by: Matthew Setter <[email protected]>
This patch incorporates feedback as provided by @froschdesign. Signed-off-by: Matthew Weier O'Phinney <[email protected]>
Updates the CHANGELOG.md to set the release date.
weierophinney
deleted the
3.1.x-merge-up-into-3.2.x_5f7c863e6e99e1.26585980
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Release Notes for 3.1.1
3.1.1
Documentation
Documentation,Enhancement,Review Needed
Bug,Documentation