Enhance DynamicOptions with expanded documentation and implementation details
#305
Conversation
This file contains hidden or 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
…on details - Revamped documentation for `Must`, `Min`, `Max`, `Inclusion`, and `Schema` classes, providing comprehensive usage examples, validation rules, and architectural insights. - Introduced detailed comments for each method, outlining purpose, parameter descriptions, return values, and relevant notes. - Made class structures clearer by improving abstraction layers and adding specific-purpose methods. - Strengthened validation logic for dynamic options, including condition checks, error messaging, and normalization processes. - Updated key sections such as "common_condition_with" logic in `Min`, `Max`, and `Inclusion` and improved schema handling.
- Updated validation documentation for `Inclusion`, `Schema`, `Target`, `Format`, and `ConsistsOf` to improve clarity and reflect current functionality. - Removed range support in `Inclusion` and emphasized arrays for inclusion sets. - Clarified default value handling in `Target` and preserved array structure for class-typed attributes. - Enhanced `Format` to better explain boolean validation and added new two-phase validation details. - Simplified `ConsistsOf` examples and clarified presence checks for different attribute types.
- Clarified whether each dynamic option requires registration or is included by default. - Updated `Min`, `Max`, `Target`, `Format`, `MultipleOf` to emphasize required registration for specific attribute types. - Revamped `Inclusion`, `Schema`, `ConsistsOf` to reflect default inclusion and customization options. - Improved examples with additional helper lists and customization insights.
- Simplified configuration examples for extending `hash_mode_class_names` in `Schema` and `collection_mode_class_names` in `ConsistsOf`. - Aligned documentation with current functionality, removing redundant helper references. - Highlighted straightforward usage of custom types like `CustomHashClass` and `ActiveRecord::Relation`.
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.
No description provided.