Update docs for preparation.ex #2317
Open
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
Based on what I could find this seems to be the valid returns for the `supports/1` callback?
Contributor
Author
|
I am not 100% sure about my explanation, but this is how I understood it :) |
zachdaniel
reviewed
Sep 10, 2025
| `c:init/1` is defined automatically by `use Ash.Resource.Preparation`, but can be implemented if you want to validate/transform any | ||
| options passed to the module. | ||
|
|
||
| `c:supports/1` is also required and returns a list containing any or all of the following: `[Ash.Changeset, Ash.Query, Ash.ActionInput]` based on what your `c:prepare/3` implementation supports |
Contributor
There was a problem hiding this comment.
required is nebulous because its not required to implement yourself. A default is provided by the use macro.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Based on what I could find this seems to be the valid returns for the
supports/1callback?Contributor checklist
Leave anything that you believe does not apply unchecked.