Fix docs around run #131
Merged
Fix docs around run #131
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
zachdaniel
reviewed
Oct 3, 2024
zachdaniel
reviewed
Oct 3, 2024
zachdaniel
reviewed
Oct 3, 2024
zachdaniel
approved these changes
Oct 3, 2024
|
Sounds good! Sorry still new to Elixir and it's documentation patterns. I'll update the PR |
The docs incorrectly suggested and showed usages of `run` with arity 3. But `run` only allows for arity 1 and 2. This patch updates the docs to show the correct usage and labeling for the function. Fixes ash-project#128
This test was warning when run. It unfortunately was getting a false positive as written due to calling `.name` on a atom rather than getting the `:name` property of the `:current_step` map. This change fixes the test and looks for the correct error message.
|
All set |
|
I'm actually not sure my suggestion was conventional or not. Either way, its right now when it was wrong before, 🙇 |
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.
This PR fixes #128 and a small test that was warning. It mostly focuses on correcting the documentation around how the anonymous
runfunction should be used within a step.Contributor checklist