Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

describeScenario docs #9706

Merged

Conversation

cjreimer
Copy link
Contributor

@cjreimer cjreimer commented Dec 14, 2023

This is the documentation for #9572 created by @dac09.

It is still in progress.

  • Prepare documentation
  • Self review-check

Note: Discussion for the creation of this feature is also here

@dthyresson dthyresson added the release:docs This PR only updates docs label Dec 14, 2023
@dthyresson dthyresson requested a review from dac09 December 14, 2023 14:49
@dthyresson dthyresson added this to the next-release-patch milestone Dec 14, 2023
@dthyresson
Copy link
Contributor

Thanks @cjreimer for these docs; I've assigned to @dac09 to review as he has the context for #9572.

docs/docs/testing.md Outdated Show resolved Hide resolved
docs/docs/testing.md Outdated Show resolved Hide resolved
docs/docs/testing.md Outdated Show resolved Hide resolved
<li>Reduce testing run time. There is an overhead to setting up and tearing down the db on each test, and in some cases a reduced testing run time may be of significant benefit. This may be of benefit where the likelihood of side-effects is low, such as in query testing
</ul>

### describeScenario Examples
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cjreimer thanks for these docs!

Should we change one of the examples to use a named scenario?

docs/docs/testing.md Outdated Show resolved Hide resolved
@dac09 dac09 changed the title defineScenario Documentation Development describeScenario Documentation Development Dec 26, 2023
@dac09 dac09 changed the base branch from main to feat/describe-scenario January 22, 2024 08:26
docs/docs/testing.md Outdated Show resolved Hide resolved
docs/docs/testing.md Outdated Show resolved Hide resolved
@dac09 dac09 changed the title describeScenario Documentation Development describeScenario docs Jan 22, 2024
@dac09 dac09 merged commit db23ea0 into redwoodjs:feat/describe-scenario Jan 22, 2024
31 checks passed
@dac09
Copy link
Contributor

dac09 commented Jan 22, 2024

Merging docs into this PR #9866 so docs and code go in together!

@cjreimer
Copy link
Contributor Author

Thank you @dac09 ! You're awesome! I did have this on my to-do list, but I apologize I had not gotten to it over the last few weeks! Thanks for unloading this off me!

@dac09
Copy link
Contributor

dac09 commented Jan 22, 2024

Thank you @dac09 ! You're awesome! I did have this on my to-do list, but I apologize I had not gotten to it over the last few weeks! Thanks for unloading this off me!

No worries at all Curtis, I felt bad for forgetting about it too 🤣 - thanks for the docs and helping put this feature together!

@jtoar jtoar modified the milestones: next-release-patch, v7.0.0 Jan 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:docs This PR only updates docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants